This project is to provide a set of requirements for a documentation system starter template, that would be compatible with the overall vision of The Good Docs Project.
Primary goals of this project:
- Help system template developers create more effective tools, by providing a comprehensive set of system requirements.
- Provide example content based on The Good Docs Project documentation Templates.
- Maintain a living inventory of compatible system template projects.
- Reduce the time required to start a new project, or modify an existing project to take advantage of The Good Docs Project Templates.
This project does not provide a working template system directly. It will be up to developers of system templates, that conform to the standard, to submit their project to the inventory for review and listing.
To submit a new project:
- Make an issue in this project to add it into the Inventory.
- Make a Pull/Merge Request that resolves the issue, with changes to the inventory data file and the inventory table.
After the Pull/Merge Request is reviewed and approved, it is up to a representative of the starter template project to maintain accurate information in the inventory regarding that project.
Users of these system templates are encouraged to provide feedback and share experiences that they have with the starter templates here in this project. Any issues/bugs or feature requests for a specific template should be made in that project's repository so that the developers can take direct action.
As this is an open source project itself, any comments, suggestions, constructive criticism, etc. are encouraged. Please feel free to make a new issue with your feedback.
If you are interested in joining us to help define the specifications and review/approve new project submissions, please join the Doc Tools - Easy Button working group.