Icon HelpCircleForumIcon Link


Icon HelpCircleForumIcon Link
GitHub Workflows

Icon LinkUnderstanding the GitHub Workflows

The docs-hub repo uses GitHub Actions to automate the process of updating the documentation, checking for broken links, and more. This page explains the different workflows and how to fix them if they fail.

Icon LinkDocSearch Scrap (docs-scrapper.yml )

This action updates the Algolia search index by scraping the live docs.fuel.network Icon Link site. It only runs when a Fuel contributor manually runs it.

Icon LinkGuides (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.

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

  • 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.

  • If possible, rewrite the sentence.

  • If it otherwise should be ignored, you can configure the pipeline in .spellcheck.yml.

To fix a failed guides test, refer to the Guides Testing section.

This workflow tests the links in the docs-hub to make sure none are broken.

Icon LinkPR Checks (pr.yml )

This workflow checks the name of the pull request, checks to make sure there are no dependency vulnerabilities, and runs a lint check for the markdown files and code.

To fix a failing PR title check, change the name of your PR so it uses the convention below:

Available types:
 - feat: A new feature
 - fix: A bug fix
 - docs: Documentation only changes
 - style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
 - refactor: A code change that neither fixes a bug nor adds a feature
 - perf: A code change that improves performance
 - test: Adding missing tests or correcting existing tests
 - build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
 - ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
 - chore: Other changes that don't modify src or test files
 - revert: Reverts a previous commit

To fix a failing audit check:

pnpm audit --fix
pnpm install

To fix a failing lint check:

pnpm lint:fix:all 

Icon LinkUpdate Latest (update-latest.yml )

This workflow runs every Monday and Thursday to update the nightly version of the documentation. See the Versions section for more information.