BAMresearch / bam-masterdata / 18492406547

53%

main: 56%

push

github

Write documentation and API docstrings into the mkdocs page (#192)

* Create comprehensive documentation following Diataxis method with automatic docstring extraction (#188)

* Initial plan

* Create comprehensive documentation following Diataxis method

Co-authored-by: JosePizarro3 <112697669+JosePizarro3@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: JosePizarro3 <112697669+JosePizarro3@users.noreply.github.com>

* Removed datamodel api and moved info to extra.md

* Removed unused References from mkdocs.yml

* Restructure tutorial.md

Deleted use_object_types.md and moved to tutorial

Updated refs

Added Lucas as contributor in the README

* Minor clean up and commenting out how-to Overview page

* Cleanup api.md and fixed docstrings

* Deleting unused config in mkdocs.yml

---------

Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>

17 of 22 new or added lines in 2 files covered. (77.27%)

998 of 1988 relevant lines covered (50.2%)

0.5 hits per line