Technical Documentation
This application is the technical documentation/remediation wiki used in conjunction with https://cddo-api-spec-linter.herokuapp.com/.
This application acts as a service to allow technical and non-technical users to update the multiple rulesets to allow developers to build API’s based off the OpenAPI Specification.
This app also acts as a Remediation Wiki to allow developers to lint their OpenAPI specs with our Linter.
Before you start
To use the Tech Docs Template you need:
Making changes
To make changes to the documentation for the Tech Docs Template website, edit files in the source folder of this repository.
You can add content by editing the .html.md.erb files. These files support content in:
- Markdown
- HTML
- Ruby
👉 You can use Markdown and HTML to generate different content types and Ruby partials to manage content.
👉 Learn more about producing more complex page structures for your website.
Preview your changes locally
To preview your new website locally, navigate to your project folder and run:
bundle exec middleman server👉 See the generated website on http://localhost:4567 in your browser. Any content changes you make to your website will be updated in real time.
To shut down the Middleman instance running on your machine, use ctrl+C.
Build
To build the HTML pages from content in your source folder, run:
bundle exec middleman build
Every time you run this command, the build folder gets generated from scratch. This means any changes to the build folder that are not part of the build command will get overwritten.
Licence
Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation.
The documentation is © Crown copyright and available under the terms of the Open Government 3.0 licence.