1# Technical Documentation
Technical Documentation for the planning data service.
This repo produces static pages which are then hosted by github but you can serve these locally to shorten the development loop.
To do this you'll need a couple of dependencies:
- node.js and npm installed locally
- make to be installed (make is used to simplify the commands to run)
This project used to use the Tech Docs Template, which is a Middleman template that you can use to build technical documentation using a GOV.UK style.
But we found that using the template required knowledge of Ruby which isn't a requirement of our project and was difficult for alll members of the team to interact with so we switched to X-GOVUK Eleventy Plugin.
We have customised the layout so that edits don't need any special knowledge other than creating and editing markdown files. To make a change simply edit the relvent document or create a new one in the docs directory and the sidenav will automatically update!