Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change documentation structure to have API and Developers docs at top level #8104

Closed
Tracked by #5559
alexgarel opened this issue Feb 14, 2023 · 0 comments · Fixed by #8162
Closed
Tracked by #5559

Change documentation structure to have API and Developers docs at top level #8104

alexgarel opened this issue Feb 14, 2023 · 0 comments · Fixed by #8162
Assignees
Labels
📚 Documentation Documentation issues improve the project for everyone. ✅ Task

Comments

@alexgarel
Copy link
Member

Documentation is a bit messed up for API users because it's mixed with developer documentation.

While we want to follow the diataxis framework, we agreed we should split documentation, and flatten the structure.

  • split in two main folders: API / Developer
  • put all files flat under it but with fix prefix for files and titles based on the role of the documentation:
    • prefix in filename: how-to- / tutorial- / explanation- / reference-
    • prefix in titles: How to … / Tutorial: / Explanation: / Reference:
    • eventually an emoji in titles for each type of documentation (if it does not break the ordering)
  • api.yml and all OpenAPI files deserve their own folder in API/reference
@alexgarel alexgarel added 📚 Documentation Documentation issues improve the project for everyone. ✅ Task labels Feb 14, 2023
@alexgarel alexgarel self-assigned this Feb 22, 2023
alexgarel added a commit that referenced this issue Mar 8, 2023
We want to have an API and a DEV entry, because mixing both is confusing for our readers.

fixes:
- #8104
@alexgarel alexgarel mentioned this issue Mar 8, 2023
3 tasks
alexgarel added a commit that referenced this issue Mar 10, 2023
* docs: restructure

We want to have an API and a DEV entry, because mixing both is confusing for our readers.

fixes:
- #8104

* docs: adding index.md and fixing warnings
alexgarel added a commit that referenced this issue Mar 10, 2023
- do not copy README as index anymore (too confusing)
- have a specific sleek index.md instead
- publish doc on makefile targets for docker
- add a doc on writing and running tests

fixes:
- #8104
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 Documentation Documentation issues improve the project for everyone. ✅ Task
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant