Skip to content
This repository has been archived by the owner on Oct 25, 2024. It is now read-only.

fix: update docs example #1364

Merged
merged 1 commit into from
Sep 20, 2023
Merged

fix: update docs example #1364

merged 1 commit into from
Sep 20, 2023

Conversation

ra0x3
Copy link
Contributor

@ra0x3 ra0x3 commented Sep 19, 2023

Thanks for opening a PR with the Fuel Indexer project. Please review the Checklist below and ensure you've completed all of the necessary steps to make this PR review as painless as possible.

Checklist

  • Ensure your top-level commit message is in line with our contributor guidelines.
  • Please add proper labels.
  • If there is an issue associated with this PR, please link the issue (right-hand sidebar)
  • If there is not an issue associated with this PR, add this PR to the "Fuel Indexer" project (right-hand sidebar)
  • Please allow Codeowners at least 24 hours to do a first-pass review.
  • Please add thoroughly detailed testing steps below.
  • Please keep your Changelog message short and sweet.

Description

Please include a short description of what this PR does.

Testing steps

Please provide the exact testing steps for the reviewer(s) if this PR requires testing.

Changelog

Please add neat Changelog info here, according to our Contributor's Guide.

@ra0x3 ra0x3 requested a review from deekerno as a code owner September 19, 2023 15:57
@ra0x3 ra0x3 self-assigned this Sep 19, 2023
@ra0x3 ra0x3 requested a review from lostman as a code owner September 19, 2023 15:57
@ra0x3 ra0x3 linked an issue Sep 19, 2023 that may be closed by this pull request
@ra0x3
Copy link
Contributor Author

ra0x3 commented Sep 19, 2023

@deekerno Could you remind me how you viewed the docs portal locally? Wanna see if this fixes things (even though apparently it doesn't show any changes)

@deekerno
Copy link
Contributor

deekerno commented Sep 19, 2023

I gotchu.


In order to read the documentation in the intended form (as part of the docs hub at docs.fuel.network), run the following steps:

  • Clone the docs hub repository -- https://github.com/FuelLabs/docs-hub -- and follow the setup instructions.
  • Open .gitmodules and add branch = [insert branch here] to the fuel-indexer section.
  • Update the submodule for the indexer repo: git submodule update --remote docs/fuel-indexer.
  • Run pnpm dev and navigate to localhost:3000 to read the docs.

@ra0x3
Copy link
Contributor Author

ra0x3 commented Sep 19, 2023

@deekerno @lostman

@ra0x3 ra0x3 changed the title fix: fix spaces vs tabs? fix: update docs example Sep 19, 2023
@ra0x3 ra0x3 merged commit 887ab38 into develop Sep 20, 2023
@ra0x3 ra0x3 deleted the rashad/tiny-docs-format-update branch September 20, 2023 17:12
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix example code formatting in docs
2 participants