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: split up getting started guide into multiple pages #2202

Merged
merged 14 commits into from May 13, 2024

Conversation

Dhaiwat10
Copy link
Member

Closes #2086

@Dhaiwat10
Copy link
Member Author

@arboleya I saw you mentioned a 'troubleshooting' page in the original issue. What would you want on this page? Do you have any rough idea/expectations?

@arboleya
Copy link
Member

Important

Brainstorming.

@Dhaiwat10 At first, I thought about having a fuels troubleshoot command that could:

  1. check for version mismatches
  2. check ts settings (example)
  3. what else?

Like a utility, it could grow with time, incorporating handy validations and gotchas—think of a brew doctor. Maybe it's overkill, but maybe not. Anyway, in this rationale, the troubleshoot doc page could be a guide about using the new command (which requires implementing the command) or simply a guide to the manual procedures one could use to double-check one's setup.

What do you think?

@Dhaiwat10
Copy link
Member Author

@arboleya I have filed an issue for the troubleshoot command. I think we should just implement it and add the docs along with it when we do it, rather than doing the docs twice.

@danielbate danielbate self-requested a review May 12, 2024 06:43
Copy link
Contributor

Coverage Report:

Lines Branches Functions Statements
79.54%(+0%) 69.84%(+0%) 77.12%(+0%) 79.65%(+0%)
Changed Files:

Coverage values did not change👌.

@Dhaiwat10 Dhaiwat10 merged commit 667ba0f into master May 13, 2024
18 checks passed
@Dhaiwat10 Dhaiwat10 deleted the dp/split-getting-started branch May 13, 2024 08:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Consider splitting Getting Started page
5 participants