search

bundestag / gesetze-tools

Scripts to maintain German law git repository
GNU Lesser General Public License v3.0
114 stars 21 forks source link

💬 [Question] Documentation #41

Closed darkdragon-001 closed 3 years ago

darkdragon-001 commented 3 years ago

:speech_balloon: Question

What type of documentation is needed? Currently, there is https://github.com/bundestag/gesetze-docs, which is mostly empty.

I suggest to keep things simple and add documentation in form of a README.md (and optionally a docs folder) to the corresponding repositories. This could then be parsed by https://readthedocs.org/ or similar. This way documentation is versioned together with the code.

Therefore I suggest to delete the gesetze-docs repository for now. @ulfgebhardt do you agree?

ulfgebhardt commented 3 years ago

Oh I did not know about https://github.com/bundestag/gesetze-docs - I will archive that repo - think thats a more non-intrusive way of handling things.

I generally think that documentation should be close to the code - those things should not be separated. I agree on the README.md and the docs/. More important then docs are automatic outputs in my opinion. If we have a working scraper the common dev should be informed how to operate it and what are system requirements to get things running. The common muggel has to be informed where he can find the automatically generated output.

darkdragon-001 commented 3 years ago

The the repo only contains placeholders and no content at all, that's why I suggested deletion but would be fine with archival as well.

Please close this issue once it's done.

ulfgebhardt commented 3 years ago

image