diff --git a/docs/README.md b/docs/README.md index 01cc185282c..18d7b20e974 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,6 +2,25 @@ This directory contains a Docusaurus documentation website for both user and developer documentation. +## Overview +The site it comprised of two sub-sites - user documentation (`/`) and developer documentation (`/developers`). There is intentionally no link from the user docs to the developer docs, to avoid overwhelming users with unnecessary info. + +### User Docs + +Available at the root (`/`), default location for anyone visiting the documentation domain. + +Follows the [Diátaxis](https://diataxis.fr/) framework for structuring documentation. The site is divided into four types of documentation: tutorials (Getting Started), how-to guides (Guides), explanations (Knowledge Base) and reference (Reference). + +#### CLI Docs +These docs are automatically generated from the Forest CLI. See [script](/docs/docs/users/reference/cli.sh). + +#### JSON-RPC Docs +We use the OpenRPC document from Forest to populate the documentation for each method. For this we use `@metamask/docusaurus-openrpc`. + +### Developer Docs + +Available at `/developers`. Comprised of a collection of documents aimed at contributors. May be relevant to power users. + ## Getting Started > Note: This project uses [Yarn](https://yarnpkg.com/getting-started/install) @@ -35,3 +54,6 @@ To compile an optimized production build: $ yarn build ``` +## Deployment + +The documentation site is continuously deployed to CloudFlare Pages, triggered on every commit to `main`. [This workflow](/.github/workflows/docs-deploy.yml) defines the deployment process. \ No newline at end of file