techdocs
techdocs copied to clipboard
Suggested doc: Documentation home best practices
Where should documentation be housed in reference to a project's code repository?
- Documentation should be separate from the code, preferably in it's own website repository. Avoid duplication, source of truth for documentation is the website
- Documentation should be stored in the primary code repo, closest to the system being documented. Monorepo-style tools/organization can be used to generate a website from there
- Other(?)
I think that the TechDocs team tends towards option a., but each project is unique and other options are valid. I think we should put together a document that outlines our arguments for and against different strategies so we can refer to it as we're helping projects make decisions around how to setup their docs repositories.