diff --git a/README.md b/README.md index d79e708..21ad6f4 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,31 @@ -# ThreeFold Docs Website +

ThreeFold Docs Website

+ +

Table of Contents

+ +- [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. -It is hosted at `docs.threefold.info`. +## URL + +The website is hosted at `docs.threefold.info`. ## Branches - `development` - code version of website - -## References - -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 +- `development_` + - See `Contribute` section for details ## Contribute @@ -30,4 +42,8 @@ To contribute to this repository, make a pull request of your changes. There are - 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` \ No newline at end of file + - 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/). \ No newline at end of file