oceanprotocol/docs
1
0
Fork 0
mirror of https://github.com/oceanprotocol/docs.git synced 2024-11-26 19:49:26 +01:00
Code Releases Activity

Update README: API & Library Reference docs now exist

Browse Source
This commit is contained in:
Troy McConaghy 2019-01-21 12:07:17 +01:00 committed by GitHub
parent 3d437aca38
commit 8d32f36298
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -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 - **Core concepts**: high-level explanation of concepts, assumptions, and components
- **Setup**: getting started for various stakeholders and use cases - **Setup**: getting started for various stakeholders and use cases
- **Tutorials**: detailed tutorials - **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. 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). 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) - [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. 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 ### Markdown File Requirements
All Markdown files should use All Markdown files should use