hackforla / hackforla/peopledepot
docs: MkDocs use of snippets for README, CONTRIBUTING, LICENSE
Open
complexity: small
feature: docs: PD team documentation
PII: FALSE
role: technical writing
s: PD team
size: 0.25pt
- Dominant language
- Python
- Stars
- 14
- Forks
- 37
- Avg merge
- 9d 15h
- Merged PRs (30d)
- 5
Description
### Overview
We need to document how we set up the project so that contents exist in a single location but satisfies both Github and MkDocs requirements that they be in different places. It's through MkDocs snippets.
### Action Items
- [ ] add documentation for snippets and how we use it in the project documentation
### Resources/Instructions
- we keep the content files in the project root and use snippets inside the docs/ directory so to keep MkDocs happy
- The LICENSE file exists in upper and lowercase intentionally. There's places that need both.
Contributor guide
Assessment
This issue has not been assessed yet.