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

Fix broken forc command docs #6424

Merged
merged 7 commits into from
Aug 19, 2024
Merged

Fix broken forc command docs #6424

merged 7 commits into from
Aug 19, 2024

Conversation

JoshuaBatty
Copy link
Member

@JoshuaBatty JoshuaBatty commented Aug 16, 2024

Description

I noticed that the command section for forc in the documentation was only showing headings and no information about the commands themselves. See below.

Screenshot 2024-08-19 at 10 47 48 AM

This was due to back ticks being placed around the heading in #5369. I've removed these ticks and added the commands to the list of accepted words.

Also there were a lot of commands being missed due to their no longer being subcommands, this logic has been updated and all the forc commands are now being parsed.

Checklist

  • I have linked to any relevant issues.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have updated the documentation where relevant (API docs, the reference, and the Sway book).
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added (or requested a maintainer to add) the necessary Breaking* or New Feature labels where relevant.
  • I have done my best to ensure that my PR adheres to the Fuel Labs Code Review Standards.
  • I have requested a review from the relevant team or maintainers.

@JoshuaBatty JoshuaBatty requested review from a team as code owners August 16, 2024 04:20
@JoshuaBatty JoshuaBatty marked this pull request as draft August 16, 2024 04:20
@JoshuaBatty JoshuaBatty self-assigned this Aug 18, 2024
@JoshuaBatty JoshuaBatty added bug Something isn't working forc documentation labels Aug 19, 2024
@JoshuaBatty JoshuaBatty marked this pull request as ready for review August 19, 2024 00:48
@JoshuaBatty JoshuaBatty requested a review from a team as a code owner August 19, 2024 00:48
@JoshuaBatty JoshuaBatty enabled auto-merge (squash) August 19, 2024 02:29
Copy link
Member

@sdankel sdankel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@JoshuaBatty JoshuaBatty mentioned this pull request Aug 19, 2024
8 tasks
@JoshuaBatty JoshuaBatty merged commit 7dc3e2d into master Aug 19, 2024
42 checks passed
@JoshuaBatty JoshuaBatty deleted the josh/forc_command_docs branch August 19, 2024 13:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation forc
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants