From 8d32f36298407467cf086919e7b90776b786a4a3 Mon Sep 17 00:00:00 2001 From: Troy McConaghy Date: Mon, 21 Jan 2019 12:07:17 +0100 Subject: [PATCH] Update README: API & Library Reference docs now exist --- README.md | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 48946997..4770b5ee 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,7 @@ The documentation is split in multiple sections whose content lives in this repo - **Core concepts**: high-level explanation of concepts, assumptions, and components - **Setup**: getting started for various stakeholders and use cases - **Tutorials**: detailed tutorials +- **API & Library References**: docs for the Aquarius & Brizo REST APIs, and docs for various Squid libraries Those sections are defined in the [`/data/sections.yml`](data/sections.yml) file. @@ -66,7 +67,7 @@ Some global values used throughout the site can be set in [`config.js`](config.j Additionally, some content files live in other repositories and are maintained there. They are pulled into Gatsby's data layer at build time, and pages are created automatically for them as defined in [gatsby-node.js](gatsby-node.js). -At the moment, this is setup for the following repositories: +At the moment, this is set up for the following repositories: - [dev-ocean](https://github.com/oceanprotocol/dev-ocean) @@ -74,12 +75,6 @@ For including a document from any of the above repositories, 4 values are requir This will NOT include this page in the doc's sidebar navigation, this needs to be done manually in the docs repo in one of the sidebar files. This is so you can check out everything before exposing it to visitors, and to ensure editorial workflow of the categorization. -TODO: In a later stage, we will include more documentation in this site, e.g.: - -- API references -- Component docs -- Maybe more - ### Markdown File Requirements All Markdown files should use