Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fixed docs errors and major typos #412

Open
wants to merge 26 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
92346af
Corrected-docs
intls Sep 5, 2024
9d7475d
Merge branch 'master' into fix-docs
intls Sep 13, 2024
5b78abf
Merge branch 'master' into fix-docs
intls Sep 16, 2024
e152d6c
Merge branch 'master' into fix-docs
intls Sep 29, 2024
c9758d7
Merge branch 'master' into fix-docs
intls Oct 3, 2024
98e1c58
Merge branch 'master' into fix-docs
intls Oct 6, 2024
ed199e5
Merge branch 'master' into fix-docs
intls Oct 8, 2024
879b2b2
Merge branch 'master' into fix-docs
intls Oct 11, 2024
683d384
Merge branch 'master' into fix-docs
intls Oct 15, 2024
2e5b1e4
Merge branch 'master' into fix-docs
intls Oct 17, 2024
962e516
Merge branch 'master' into fix-docs
intls Oct 19, 2024
d66f51c
Merge branch 'master' into fix-docs
intls Oct 22, 2024
f385497
Merge branch 'master' into fix-docs
intls Oct 30, 2024
5c0967c
Merge branch 'master' into fix-docs
intls Nov 19, 2024
4fe67cd
Merge branch 'master' into fix-docs
intls Nov 25, 2024
67a9ae3
Merge branch 'master' into fix-docs
intls Dec 4, 2024
49e5278
Merge branch 'master' into fix-docs
intls Dec 9, 2024
fa2ea51
Merge branch 'master' into fix-docs
intls Dec 10, 2024
60c0643
Merge branch 'master' into fix-docs
intls Dec 11, 2024
53c2094
Merge branch 'master' into fix-docs
intls Dec 17, 2024
4bfe683
Merge branch 'master' into fix-docs
intls Dec 20, 2024
1ad9979
Merge branch 'master' into fix-docs
intls Jan 4, 2025
06b3356
Merge branch 'master' into fix-docs
intls Jan 14, 2025
27f9e2f
Merge branch 'master' into fix-docs
intls Jan 17, 2025
30fa6c9
Merge branch 'master' into fix-docs
intls Feb 7, 2025
d6cdf7d
Merge branch 'master' into fix-docs
intls Feb 10, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/contributing/general.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
4 changes: 2 additions & 2 deletions docs/contributing/github-workflows.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/guides.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/contributing/style-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/contributing/versions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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:

Expand Down