bundesAPI / bundesAPI/deutschland

Documentation - Suggestions

Open
#43 5 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
HTML
Stars
1.4k
Forks
83
PR merge metrics
No merged PRs in 30d

Description

I started to work on the documentation (see #41) and I have a few suggestions:

- Include source-code documentation into sphinx
- Provide the documentation in both german and english
- Rethink the README - currently it is a mix of quickstart, documentation for specific apis and links to more documentation on autogenerated api-clients; IMO it should only contain a short description of the repo, how to install it and where to find more documentation
- Provide an Issue template for documentation related issues and tag them as _documentation_, which would make it easier to plan and track documentation progress and allow to filter bugs and other issues.
- Host the documentation on [readthedocs](https://readthedocs.io) (@LilithWittmann thats something you should [look into](https://docs.readthedocs.io/en/stable/tutorial/))

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.