mirror of
https://github.com/oceanprotocol/docs.git
synced 2024-11-26 19:49:26 +01:00
content restructuring, document content
This commit is contained in:
parent
28ad87ded1
commit
b37159a5d6
35
README.md
35
README.md
@ -16,31 +16,60 @@
|
||||
---
|
||||
|
||||
- [Content](#content)
|
||||
- [Sections](#sections)
|
||||
- [Editing docs](#editing-docs)
|
||||
- [Adding docs](#adding-docs)
|
||||
- [Repositories](#repositories)
|
||||
- [Development](#development)
|
||||
- [Authors](#authors)
|
||||
- [License](#license)
|
||||
|
||||
## Content
|
||||
|
||||
...documentation concept...
|
||||
All content lives in the [`/content`](content/) & [`/data`](data/) folders utilizing GitHub Flavored Markdown and YAML. Content is organized into the above mentioned categories through subfolders. Those subfolder names, along with the file name, define the final url of a given piece of content.
|
||||
|
||||
The documentation is split in multiple parts whose content lives in this repo:
|
||||
The final navigational organisation of the content is driven through the sidebar files under [`/data/sidebars`](data/sidebars/).
|
||||
|
||||
### Sections
|
||||
|
||||
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
|
||||
|
||||
Additionally, these docs live in their respective repos and are pulled into this site on build time:
|
||||
Those sections and their copy are defined in the [`/data/sections.yml`](data/sections.yml) file.
|
||||
|
||||
TODO: Additionally, these docs live in their respective repos and are pulled into this site on build time:
|
||||
|
||||
- API reference
|
||||
- Component docs
|
||||
|
||||
### Editing docs
|
||||
|
||||
Every article on [docs.oceanprotocol.com](https://docs.oceanprotocol.com) ends with an _Edit this page on GitHub_ link. Clicking that will put you to the right place in the repository from where you can hit the _Edit_ pencil icon.
|
||||
|
||||
GitHub will automatically fork the repository if you are not part of the `oceanprotocol` organisation on GitHub. Members can simply push to a new branch on the original repo.
|
||||
|
||||
The editing workflow is as follows:
|
||||
|
||||
1. Make your changes
|
||||
2. Push your changes to a new branch in the repo, or in your fork
|
||||
3. Open a pull request against `master`, automatically asking for review
|
||||
4. Wait for review, possibly make request changes
|
||||
5. Wait for all checks to pass
|
||||
6. Merge!
|
||||
|
||||
### Adding docs
|
||||
|
||||
...
|
||||
|
||||
### Repositories
|
||||
|
||||
The repositories list is currently sourced from the [`/data/repositories.yml`](data/repositories.yml) file. The GitHub link is auto generated from the given repository name and will always be added by default.
|
||||
|
||||
- [`/data/repositories.yml`](data/repositories.yml)
|
||||
|
||||
## Development
|
||||
|
||||
The site is a React app built with [Gatsby](https://www.gatsbyjs.org), pulling its content from various sources.
|
||||
|
@ -5,5 +5,6 @@ description: Help with Ocean Protocol development and have Ocean Tokens rain on
|
||||
|
||||
Explain our bounties
|
||||
|
||||
- [🎣 ocean-bounties](https://github.com/oceanprotocol/ocean-bounties/issues)
|
||||
- [Gitcoin](https://gitcoin.co/profile/oceanprotocol)
|
||||
- [bounties.network](https://explorer.bounties.network/explorer?bountyStage=active&search=ocean%20protocol)
|
||||
|
@ -1,8 +1,14 @@
|
||||
- group: Setup Guides
|
||||
- group: Marketplaces
|
||||
items:
|
||||
- title: Set Up a Marketplace
|
||||
link: /setup/marketplace/
|
||||
|
||||
- group: Keeper
|
||||
items:
|
||||
- title: Set Up a Keeper
|
||||
link: /setup/keeper/
|
||||
|
||||
- group: Publisher
|
||||
items:
|
||||
- title: Publish Data or Services
|
||||
link: /setup/publisher/
|
||||
|
@ -11,6 +11,7 @@
|
||||
|
||||
a {
|
||||
font-family: $font-family-button;
|
||||
font-weight: $font-weight-bold;
|
||||
text-transform: uppercase;
|
||||
color: $brand-grey-light;
|
||||
margin: 0 $spacer / 2;
|
||||
|
@ -27,7 +27,7 @@
|
||||
|
||||
.headerTitle {
|
||||
margin-bottom: $spacer;
|
||||
font-size: $font-size-h3;
|
||||
font-size: $font-size-h2;
|
||||
animation-delay: .2s;
|
||||
|
||||
@media (min-width: $break-point--small) {
|
||||
|
@ -28,4 +28,10 @@
|
||||
|
||||
&:before { display: none; }
|
||||
}
|
||||
|
||||
a {
|
||||
font-family: $font-family-button;
|
||||
font-size: $font-size-small;
|
||||
font-weight: $font-weight-bold;
|
||||
}
|
||||
}
|
||||
|
@ -36,6 +36,10 @@
|
||||
&:hover,
|
||||
&:focus {
|
||||
box-shadow: rgba($brand-black, .15) 0px 12px 20px;
|
||||
|
||||
svg {
|
||||
transform: translate3d(.2rem, 0, 0);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@ -65,11 +69,14 @@
|
||||
margin-top: $spacer / $line-height;
|
||||
color: $brand-pink;
|
||||
width: 100%;
|
||||
font-family: $font-family-button;
|
||||
font-weight: $font-weight-bold;
|
||||
|
||||
svg {
|
||||
display: inline-block;
|
||||
width: $font-size-small;
|
||||
height: $font-size-small;
|
||||
fill: $brand-grey-light;
|
||||
transition: transform .2s ease-out;
|
||||
}
|
||||
}
|
||||
|
Loading…
Reference in New Issue
Block a user