The Chronologue project is a completely fictional open source project used to illustrate what good documentation looks like in practice.
Chronologue helps you see what the The Good Docs Project templates look like in action, with actual content.
We could link to real projects that have great documentation (whether or not they use our templates) but we would have to keep checking to make sure our recommendations and those projects' docs were still in sync.
By using a fictional project we can also give examples of what not to do without hurting anyone's feelings.
On our main branch, we store the code for the Chronologue website and its API.
On our docs branch, we store the code for the Chronologue documentation.
The website is built with next.js. We use Netlify functions to make our API come to life.
We protected this branch to ensure we work together smoothly. Branch protection rules:
- You can't delete this branch
- You can't force push on this branch
As we get more developers for the Chronologue website, we might add additional branch protection rules.
We are in the process of building the initial version of the Chronologue documentation. Until we have released the first version, we keep a summary of our knowledge in the Chronologue Wiki.
We protected this branch to ensure we work together smoothly. Branch protection rules:
- You can't delete this branch.
- You can't force push on this branch.
- You can't commit directly onto the branch. You have to open a PR.
- You need at least 1 approval to merge the branch.
Chronologue is primarily an educational resource. You are free to link to, reproduce, or repurpose this text, within the bounds of our license.
We hope you find Chronologue useful as a way to explore technical writing and open source project documentation using templates.
👋 Say hi in our slack channel.
📆 Attend a Chronologue meeting. See the calendar for meeting details.
📄 Check out what we did so far in our meeting notes