From a7117973c7119d7d411185bba0886d0eb8d74688 Mon Sep 17 00:00:00 2001 From: baarkerlounger <5101747+baarkerlounger@users.noreply.github.com> Date: Wed, 13 Jul 2022 10:26:50 +0100 Subject: [PATCH] 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 * Single title Co-authored-by: Paul Robert Lloyd --- README.md | 16 ---------------- docs/documentation_website.md | 19 +++++++++++++++++++ 2 files changed, 19 insertions(+), 16 deletions(-) create mode 100644 docs/documentation_website.md diff --git a/README.md b/README.md index be43bbd82..cccb080f2 100644 --- a/README.md +++ b/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)) * [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:\ - - ## System architecture ![View of system architecture](docs/images/architecture.drawio.png) diff --git a/docs/documentation_website.md b/docs/documentation_website.md new file mode 100644 index 000000000..ed1f1633e --- /dev/null +++ b/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:\ +