Browse Source

Move doc website docs to do website (#733)

* Move doc website docs to do website

* Update docs/documentation_website.md

Co-authored-by: Paul Robert Lloyd <paulrobertlloyd@users.noreply.github.com>

* Single title

Co-authored-by: Paul Robert Lloyd <paulrobertlloyd@users.noreply.github.com>
pull/742/head
baarkerlounger 2 years ago committed by GitHub
parent
commit
a7117973c7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 16
      README.md
  2. 19
      docs/documentation_website.md

16
README.md

@ -13,22 +13,6 @@ Ruby on Rails app that handles the submission of lettings and sales of social ho
* [API browser](https://communitiesuk.github.io/submit-social-housing-lettings-and-sales-data/api) (using this [OpenAPI specification](docs/api/v1.json)) * [API browser](https://communitiesuk.github.io/submit-social-housing-lettings-and-sales-data/api) (using this [OpenAPI specification](docs/api/v1.json))
* [Design history](https://core-design-history.herokuapp.com) * [Design history](https://core-design-history.herokuapp.com)
### Running documentation locally
The documentation website can be generated and served locally using Jekyll.
1. Change into the `/docs/` directory:\
`cd docs`
2. Install Jekyll and its dependencies:\
`bundle install`
3. Start the Jekyll server:\
`bundle exec jekyll serve`
4. View the website:\
<http://localhost:4000>
## System architecture ## System architecture
![View of system architecture](docs/images/architecture.drawio.png) ![View of system architecture](docs/images/architecture.drawio.png)

19
docs/documentation_website.md

@ -0,0 +1,19 @@
---
nav_order: 10
---
# This documentation website
The documentation website can be generated and run locally using Jekyll.
1. Change into the `/docs/` directory:\
`cd docs`
2. Install Jekyll and its dependencies:\
`bundle install`
3. Start the Jekyll server:\
`bundle exec jekyll serve`
4. View the website:\
<http://localhost:4000>
Loading…
Cancel
Save