diff --git a/docs/contributing/general.mdx b/docs/contributing/general.mdx index 18a877dd0..d69296c66 100644 --- a/docs/contributing/general.mdx +++ b/docs/contributing/general.mdx @@ -40,7 +40,7 @@ This is a rough outline of what a contributor's workflow looks like: ### Linking issues -If the pull request resolves the relevant issues, and you want GitHub to close these issues automatically after it merged into the default branch, you can use the syntax (`KEYWORD #ISSUE-NUMBER`) like this: +If the pull request resolves the relevant issues, and you want GitHub to close these issues automatically after it is merged into the default branch, you can use the syntax (`KEYWORD #ISSUE-NUMBER`) like this: ```md close #123 @@ -62,5 +62,5 @@ close #123, ref #456 If you notice any bugs in the live website, please create a [new issue](https://github.com/FuelLabs/docs-hub/issues/new) on GitHub with: -- a description of the bug -- step-by-step instructions for how to reproduce the bug +- a description of the bug. +- step-by-step instructions for how to reproduce the bug. diff --git a/docs/contributing/github-workflows.mdx b/docs/contributing/github-workflows.mdx index 2eb8d0fd7..cf2824e03 100644 --- a/docs/contributing/github-workflows.mdx +++ b/docs/contributing/github-workflows.mdx @@ -16,13 +16,13 @@ This action updates the Algolia search index by scraping the live [docs.fuel.net ## Guides (`guides.yml` ) -This action runs a spell check on all the guides to catch any mispelled words. It also runs Playwright tests for some of the guides to make sure they work as expected. +This action runs a spell check on all the guides to catch any misspelled words. It also runs Playwright tests for some of the guides to make sure they work as expected. The files checked for spelling are configured in `.spellcheck.yml`. This is also where you can configure what types of elements are ignored. If the spell check test fails: -- look up the word in the question to verify it is a real word and is correctly spelled +- look up the word in the question to verify it is a real word and is correctly spelled. - If it is a file name or is code, use backticks to ignore the word. - If it is a real word that is spelled correctly, or an acronym that is either common or is defined already, add it to `spell-check-custom-words.txt`. diff --git a/docs/contributing/guides.mdx b/docs/contributing/guides.mdx index 0fb306e38..432cf6b1c 100644 --- a/docs/contributing/guides.mdx +++ b/docs/contributing/guides.mdx @@ -12,7 +12,7 @@ All guides can be found in the [`docs/guides`](https://github.com/FuelLabs/docs- The guide content is in the [`docs/guides/docs`](https://github.com/FuelLabs/docs-hub/tree/master/docs/guides/docs) folder while the example code is found in the [`docs/guides/examples`](https://github.com/FuelLabs/docs-hub/tree/master/docs/guides/examples) folder. -Note that the some content is pulled in from submodules. To make any changes to the content or code from a submodule, you must make a pull request on the source repo. +Note that some content is pulled in from submodules. To make any changes to the content or code from a submodule, you must make a pull request on the source repo. ## Style Guide diff --git a/docs/contributing/style-guide.mdx b/docs/contributing/style-guide.mdx index 215b5693e..eb596e736 100644 --- a/docs/contributing/style-guide.mdx +++ b/docs/contributing/style-guide.mdx @@ -74,9 +74,9 @@ To maintain accuracy and consistency, it is recommended to use the available Rea - For images, use the `Box.Centered` component to center the image. - For content only applicable to a certain version of the docs, use the `ConditionalContent` component. -You can find examples for how to these components within the [`docs/guides/docs`](https://github.com/FuelLabs/docs-hub/tree/master/docs/guides/docs) folder. +You can find examples of how to use these components within the [`docs/guides/docs`](https://github.com/FuelLabs/docs-hub/tree/master/docs/guides/docs) folder. -For a full list of components available, see the [`src/components/MDXRender.tsx`](https://github.com/FuelLabs/docs-hub/blob/master/src/components/MDXRender.tsx) component. +For a full list of available components, see the [`src/components/MDXRender.tsx`](https://github.com/FuelLabs/docs-hub/blob/master/src/components/MDXRender.tsx) component. ### Variables diff --git a/docs/contributing/versions.mdx b/docs/contributing/versions.mdx index bac3ead07..12c9710d0 100644 --- a/docs/contributing/versions.mdx +++ b/docs/contributing/versions.mdx @@ -8,7 +8,7 @@ parent: # Versions -There are two version sets of the docs available in the `docs-hub`: `testnet`(the default version), and `nightly`. +There are two version sets of the docs available in the `docs-hub`: `testnet` (the default version), and `nightly`. - The default version set is compatible with the `latest` toolchain and testnet. - The `nightly` version set reflects the latest releases on GitHub. These versions may not be compatible with each other. @@ -33,7 +33,7 @@ To change the default versions, update the [`src/config/versions.json`](https:// pnpm docs:update ``` -This command will both update the the default versions to match the configuration file and make sure the nightly versions are updated. +This command will both update the default versions to match the configuration file and make sure the nightly versions are updated. Here is how to decide what default versions to use: