Design patterns
Jump to navigation
Jump to search
Development
The wiki-as-submodule pattern
The wiki-as-submodule pattern proposes to
- Embed your API documentation in a wiki
- Include this wiki as a git submodule
This way:
- Documentation can be improved by anyone without the need of formal approval. User don't need access to the codebase to update documentation.
- Documentation and code can be searched together in the same tree
- Documentation and code are sync'ed with version control.
Note that on GitHub, all projects receive a wiki for free.