Documentation template for OS2 projects

🏗️ Getting started

This is a bare-minimum template to create a Jekyll site that:

• uses the Just the Docs theme;
• can be built and published on GitHub Pages;
• can be built and previewed locally, and published on other platforms.

Browse documentation to learn more about how to use this theme.

Documentation in OS2 products must follow the documentation criteria from the Standard for Public Code

1. Document your codebase objectives
2. Document the Code

Following these criteria not only opens up our codebase and fosters collaboration and transparency, but also encourages more organizations to use and adapt our open source products.

Contributing

Feel free to contribute, suggest an issue or submit a pull request with your improvements to this template.

Licensing and Attribution

This repository is licensed under the MIT License. You are generally free to reuse or extend upon this code as you see fit; just include the original copy of the license (which is preserved when you "make a template"). While it's not necessary, we'd love to hear from you if you do use this template, and how we can improve it for future use!

The deployment GitHub Actions workflow is heavily based on GitHub's mixed-party starter workflows. A copy of their MIT License is available in actions/starter-workflows.

[^1]: It can take up to 10 minutes for changes to your site to publish after you push the changes to GitHub.