Update README.md

This commit is contained in:
mik-tf 2024-08-26 19:38:35 +00:00
parent 03e381388b
commit 207419d6ce

View File

@ -2,17 +2,32 @@
This repository contains the code to the ThreeFold Docs website. This repository contains the code to the ThreeFold Docs website.
It is hosted at `threefold.info/docs`. It is hosted at `docs.threefold.info`.
## Branches ## Branches
- `development` - `development`
- code version of website - code version of website
- `gh-pages`
- deploy version of website
## References ## References
This website is written with [Docusaurus](https://docusaurus.io/). 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 The docusaurus website itself has amazing features and the code can be read here: https://github.com/facebook/docusaurus/tree/main/website
## Contribute
To optimize updates to this repository, we propose a uniform way to collaborate.
### Branches and Forks
To contribute to this repository, make a pull request of your changes. There are two main methods.
1. Fork the repository and make a pull request with your changes
2. If you have access, create a new branch in this repo and make a pull request with your changes
### Overview
- 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_`.
- The name of the branch should indicate the work being done, e.g. working on the readme, `development_readme_work`