High Fidelity User Documentation
Tools Used: Sphinx | Read the Docs | GitHub | Markdown | reStructuredText (RST) | CSS | HTML5 | Paint.NET
In this project, I retained content from Markdown files and used them to create a robust documentation system that includes:
- Mature, clean and customizable HTML themes to provide a great user experience
- Advanced full-text search functionality
- Content reuse through includes
- Referencing across multiple pages and projects
- Single source publishing (HTML, PDF, ePub and more)
- Version control
The High Fidelity documentation system uses Sphinx to generate the documentation, and Read the Docs to publish/host it. GitHub serves as a helpful middleman to store all of the source files for the docs.
High Fidelity is available as an open-source platform, and all content is forked and hosted according to the distribution requirements set out in the Apache License 2.0.
