Proposal for docs in repo #21
Description
Summary
Keep documentation within the repo instead of a remote wiki or Github wiki.
Rationale
From a developer experience perspective, it is easier to clone and have everything you need to reference locally rather than having to externally reference something.
This minimises context switching and aids the practice of keeping documentation updated as it is closer to the codebase.
Solution Proposal
Leverage automatic documentation generation via https://squidfunk.github.io/mkdocs-material.
This integrates well with Github, providing automatic docs for your repo at <username>.github.io/<repository>.
Sample structure:
docs
├── ci
│ ├── gitleaks.md
│ ├── golang-ci.md
│ └── semantic-release.md
└── starter.md # docs on how to get started with this repo
Example:
Generated from ./docs directory:
https://github.com/urfave/cli/tree/main/docs