Scaffold a documentation wiki (not using the GitHub wiki feature) under the repository root. A good folder name would be /Documentation (please use singular form for consistency).
Include a page describing the wiki expectations:
Documentation is updated in the same commit that updates code.
Page hierarchy (sections) matches the folder structure.
Markdown format is strongly preferred, but HTML is acceptable if necessary.
Commit authors are responsible for updating documentation.
Wiki folder is not added to the solution. If we did that, then every new page will have to be created through an IDE or else the solution will be missing files.
Why not the built-in wiki system?
It requires a separate repo. Git subtree can be used, but then we can't have hybrid commits (code + docs in the same commit).
warriordog
commented
1 year ago
Scaffold a documentation wiki (not using the GitHub wiki feature) under the repository root. A good folder name would be
/Documentation(please use singular form for consistency).Include a page describing the wiki expectations:
Why not the built-in wiki system?