Azure / Azure/azure-sdk-for-python
Propose documentation layout specification
- Dominant language
- Python
- Stars
- 5.6k
- Forks
- 3.4k
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 193
Description
We should have a relatively common layout for repository documentation, such that an agent can determine where to look for a category of guidance regardless of programming language. For example:
```text
azure-sdk-for-*/
|
--> doc/
|
--> contribution/
| |
| -->
| |
| --> {service}/
| |
| -->
--> usage/
|
-->
```
The divisions should be clearly separated by intended audience and scope.
Note: we should still follow standard conventions where applicable. For example, open-source repositories should have a `CONTRIBUTING.md` describing how to contribute as a developer -- we should keep `CONTRIBUTING.md` files and maybe use them as an index to point to where our specific documentation lives. This also allows us to prompt engineer in a way by assigning weight to particular sources/categories.
To help guide categorization, we can refer to this summary of documentation practices across language repos: https://gist.github.com/christothes/d05ac1c1bec2510e0fd5f90cc8eac1ae
Contributor guide
Assessment
This issue has not been assessed yet.