-
-
Notifications
You must be signed in to change notification settings - Fork 583
Documentation improvements #865
Copy link
Copy link
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomers
Description
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationgood first issueGood for newcomersGood for newcomers
Would be nice to have docs maturity as in this wonderful project:
https://github.com/SFTtech/openage?tab=readme-ov-file#contributing
https://github.com/SFTtech/openage/blob/master/doc/project_structure.md
You can also quickly check this video (first 19mins) about openage for understand why it's important.
In the end, it will move to a separate repo and, with high probability, mkdocs (as @MaxymVlasov has a few ready-to-go configs for it), but firstly/in parallel, we need to improve our docs to a much higher level.
This issue is a huge topic and can include dozen of sub-issues, but if you wanna start with this project and have no idea how to begin - try to familiarize yourself with docs and codebase, make assumptions by writing docs and we will help you (and then others) understand what is going on here by clarifying your findings