Update README.md
This commit is contained in:
parent
207419d6ce
commit
0a808fb7e9
32
README.md
32
README.md
@ -1,19 +1,31 @@
|
|||||||
# ThreeFold Docs Website
|
<h1> ThreeFold Docs Website </h1>
|
||||||
|
|
||||||
|
<h2>Table of Contents</h2>
|
||||||
|
|
||||||
|
- [Introduction](#introduction)
|
||||||
|
- [URL](#url)
|
||||||
|
- [Branches](#branches)
|
||||||
|
- [Contribute](#contribute)
|
||||||
|
- [Branches and Forks](#branches-and-forks)
|
||||||
|
- [Overview](#overview)
|
||||||
|
- [References](#references)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Introduction
|
||||||
|
|
||||||
This repository contains the code to the ThreeFold Docs website.
|
This repository contains the code to the ThreeFold Docs website.
|
||||||
|
|
||||||
It is hosted at `docs.threefold.info`.
|
## URL
|
||||||
|
|
||||||
|
The website is hosted at `docs.threefold.info`.
|
||||||
|
|
||||||
## Branches
|
## Branches
|
||||||
|
|
||||||
- `development`
|
- `development`
|
||||||
- code version of website
|
- code version of website
|
||||||
|
- `development_<suffix>`
|
||||||
## References
|
- See `Contribute` section for details
|
||||||
|
|
||||||
This website is written with [Docusaurus](https://docusaurus.io/).
|
|
||||||
|
|
||||||
The docusaurus website itself has amazing features and the code can be read here: https://github.com/facebook/docusaurus/tree/main/website
|
|
||||||
|
|
||||||
## Contribute
|
## Contribute
|
||||||
|
|
||||||
@ -31,3 +43,7 @@ To contribute to this repository, make a pull request of your changes. There are
|
|||||||
- The production-ready content is published on the **development** branch
|
- The production-ready content is published on the **development** branch
|
||||||
- Any changes to development must go through a pull request (PR) and its associated review from a different branch with the prefix `development_`.
|
- Any changes to development must go through a pull request (PR) and its associated review from a different branch with the prefix `development_`.
|
||||||
- The name of the branch should indicate the work being done, e.g. working on the readme, `development_readme_work`
|
- The name of the branch should indicate the work being done, e.g. working on the readme, `development_readme_work`
|
||||||
|
|
||||||
|
## References
|
||||||
|
|
||||||
|
This website is written with [Docusaurus](https://docusaurus.io/).
|
Loading…
Reference in New Issue
Block a user