From fdacf238030139932937988c89dd9566e89979c7 Mon Sep 17 00:00:00 2001 From: James Ramm Date: Fri, 28 Dec 2018 11:05:31 +0100 Subject: [PATCH] Gitbook setup --- .gitbook.yaml | 5 +++++ .github/README.md | 2 -- docs/README.md | 4 ++++ docs/SUMMARY.md | 18 ++++++++++++++++++ docs/walkthrough/introduction.md | 4 ++++ longclaw/README.md | 2 -- longclaw/{client.md => client/README.md} | 0 7 files changed, 31 insertions(+), 4 deletions(-) create mode 100644 .gitbook.yaml delete mode 100644 .github/README.md create mode 100644 docs/README.md create mode 100644 docs/SUMMARY.md create mode 100644 docs/walkthrough/introduction.md delete mode 100644 longclaw/README.md rename longclaw/{client.md => client/README.md} (100%) diff --git a/.gitbook.yaml b/.gitbook.yaml new file mode 100644 index 0000000..9f7cb00 --- /dev/null +++ b/.gitbook.yaml @@ -0,0 +1,5 @@ +root: ./docs +structure: + readme: README.md + summary: SUMMARY.md +​ \ No newline at end of file diff --git a/.github/README.md b/.github/README.md deleted file mode 100644 index c41e0e0..0000000 --- a/.github/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# .github - diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..131c071 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,4 @@ +# Longclaw User Guide + +Longclaw is an e-commerce extension for Wagtail CMS +Take a look at the walkthrough for a comprehensive setup guide. diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md new file mode 100644 index 0000000..b23151f --- /dev/null +++ b/docs/SUMMARY.md @@ -0,0 +1,18 @@ +# Summary +​ +## Walkthrough +​ +* [Introduction](walkthrough/introduction.md) +* [Setup](walkthrough/setup.md) +* [Creating Products](walkthrough/products.md) +* [Configuring Shipping](walkthrough/shipping.md) +* [Displaying Products](walkthrough/frontend.md) +* [Displaying the Basket](walkthrough/basket.md) +* [Checkout Process](walkthrough/checkout.md) +* [Fulfilling Orders](walkthrough/orders.md) + +## Usage Guide +​ +* [Introduction](introduction.md) + +## Development Guide \ No newline at end of file diff --git a/docs/walkthrough/introduction.md b/docs/walkthrough/introduction.md new file mode 100644 index 0000000..9d0c535 --- /dev/null +++ b/docs/walkthrough/introduction.md @@ -0,0 +1,4 @@ +# The Longclaw Bakery Tutorial + +This tutorial will take you through the entire process of setting up an online shop using Longclaw. +We will create a fictional bakery, where customers can order bread online. \ No newline at end of file diff --git a/longclaw/README.md b/longclaw/README.md deleted file mode 100644 index 04927ab..0000000 --- a/longclaw/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# longclaw - diff --git a/longclaw/client.md b/longclaw/client/README.md similarity index 100% rename from longclaw/client.md rename to longclaw/client/README.md