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

API & Library References -> API References

Browse Source
This commit is contained in:
Matthias Kretschmann 2019-04-17 13:05:56 +02:00
parent 8fef5459f7
commit 78f91aea44
Signed by: m
GPG Key ID: 606EEEF3C479A91F
2 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -27,7 +27,7 @@
- [Repositories](#repositories) - [Repositories](#repositories)
- [Add Links to a Repository](#add-links-to-a-repository) - [Add Links to a Repository](#add-links-to-a-repository)
- [Release Versions](#release-versions) - [Release Versions](#release-versions)
- [API & Library References](#api--library-references) - [API References](#api-references)
- [Swagger specs](#swagger-specs) - [Swagger specs](#swagger-specs)
- [TypeDoc specs](#typedoc-specs) - [TypeDoc specs](#typedoc-specs)
- [Development](#development) - [Development](#development)
@ -49,7 +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 - **API 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.
@ -184,7 +184,7 @@ The GitHub link is automatically added for every repository and will always be d
The displayed version number is based on the tag name of the latest release for a given repository. That means only GitHub releases will trigger a version number update, creating a new Git tag alone is not sufficient. The displayed version number is based on the tag name of the latest release for a given repository. That means only GitHub releases will trigger a version number update, creating a new Git tag alone is not sufficient.
### API & Library References ### API References
You can add more Markdown documents under `/content/references/`, link to them from the [`/data/sidebars/references.yml`](./data/sidebars/references.yml), and they will appear just like in all the other sections. You can add more Markdown documents under `/content/references/`, link to them from the [`/data/sidebars/references.yml`](./data/sidebars/references.yml), and they will appear just like in all the other sections.

2
data/sections.yml
View File

@ -13,7 +13,7 @@
link: /tutorials/introduction/ link: /tutorials/introduction/
color: orange color: orange
- title: API & Library References - title: API References
description: Get the references for REST APIs and library methods for all relevant components. description: Get the references for REST APIs and library methods for all relevant components.
link: /references/introduction/ link: /references/introduction/
color: green color: green