From 5656dc6a778aee9049f0c60787e5e6e9e9e1a56c Mon Sep 17 00:00:00 2001 From: David Ansermino <14164624+ansermino@users.noreply.github.com> Date: Thu, 19 Dec 2024 13:08:56 -0500 Subject: [PATCH 1/3] Update docs readme --- docs/README.md | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/docs/README.md b/docs/README.md index 9b02c672ab4..01cc185282c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,32 +2,36 @@ This directory contains a Docusaurus documentation website for both user and developer documentation. +## Getting Started + +> Note: This project uses [Yarn](https://yarnpkg.com/getting-started/install) + ### Installation +Install the required dependencies: ``` $ yarn ``` ### Local Development - +Start local development server: ``` $ yarn start ``` -This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. - -### Spellcheck +### CI Checks +These commands are recommended to run before commiting code. They run as checks in CI. ``` -yarn spellcheck +yarn spellcheck # Checks spelling +yarn format # Run prettier to fix formatting issues +yarn typecheck # Validate typescript files ``` - -You can add unknown words to `dictionary.txt`. +> **How to Fix Spellcheck Errors:** You can add unknown words to `dictionary.txt`. ### Build - +To compile an optimized production build: ``` $ yarn build ``` -This command generates static content into the `build` directory and can be served using any static contents hosting service. From 92f35e58af133936fe2e5532b98c95fe2b6cf6ce Mon Sep 17 00:00:00 2001 From: David Ansermino <14164624+ansermino@users.noreply.github.com> Date: Thu, 19 Dec 2024 13:28:17 -0500 Subject: [PATCH 2/3] Remove refs to old docs url --- CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b95617ff71f..85642398216 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -37,7 +37,7 @@ forward to your contributions. 🎉 ## I Have a Question > If you want to ask a question, we assume that you have read the available -> [Documentation](https://forest-docs-v2.pages.dev/). +> [Documentation](https://docs.forest.chainsafe.io/). Before you ask a question, it is best to search for existing [Issues](https://github.com/ChainSafe/forest/issues) or @@ -82,7 +82,7 @@ steps in advance to help us fix any potential bug as fast as possible. - Make sure that you are using the latest version. - Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the - [documentation](https://forest-docs-v2.pages.dev/). If you are looking for + [documentation](https://docs.forest.chainsafe.io/). If you are looking for support, you might want to check [this section](#i-have-a-question)). - To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing @@ -143,7 +143,7 @@ community to understand your suggestion and find related suggestions. #### 🎯 Before Submitting an Enhancement - Make sure that you are using the latest version. -- Read the [documentation](https://forest-docs-v2.pages.dev/) carefully and find +- Read the [documentation](https://docs.forest.chainsafe.io/) carefully and find out if the functionality is already covered, maybe by an individual configuration. - Perform a [search](https://github.com/ChainSafe/forest/issues) to see if the @@ -225,7 +225,7 @@ eternally grateful and hope you will continue to contribute to the project. ### 📚 Improving The Documentation The documentation is currently hosted on -[forest-docs-v2.pages.dev](https://forest-docs-v2.pages.dev/). If you find any +[docs.forest.chainsafe.io](https://docs.forest.chainsafe.io/). If you find any issues with the documentation, please create an issue as the repository is not public yet. From df20b7942185b7fd48fbe401988271720a324916 Mon Sep 17 00:00:00 2001 From: David Ansermino <14164624+ansermino@users.noreply.github.com> Date: Thu, 19 Dec 2024 13:48:35 -0500 Subject: [PATCH 3/3] Expand readme --- docs/README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) 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