Skip to content

docs: improve ONBOARDING.md with worked example and FAQ (#82)#86

Merged
q-soriarty merged 1 commit intodevelopfrom
docs/82-improve-onboarding
Mar 27, 2026
Merged

docs: improve ONBOARDING.md with worked example and FAQ (#82)#86
q-soriarty merged 1 commit intodevelopfrom
docs/82-improve-onboarding

Conversation

@q-soriarty
Copy link
Copy Markdown
Contributor

@q-soriarty q-soriarty commented Mar 27, 2026

Summary

  • Update install instructions to use platform-specific scripts (symlink)
  • Add "Worked Example" section: complete bug fix walkthrough from issue to cleanup
  • Add FAQ section with 5 common questions

Closes #82

Test plan

  • Worked example section present with complete command sequence
  • FAQ section present with 5 questions
  • Install instructions reference platform scripts
  • Lint passes

Add complete contribution walkthrough, update install instructions
to use platform scripts, and add 5 frequently asked questions.
@q-soriarty q-soriarty merged commit 3faf3ba into develop Mar 27, 2026
1 check passed
@q-soriarty q-soriarty deleted the docs/82-improve-onboarding branch March 27, 2026 23:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant