Skip to content

docs: add development setup instructions#14

Merged
jeremyeder merged 1 commit intomainfrom
docs/setup-instructions
Jan 8, 2026
Merged

docs: add development setup instructions#14
jeremyeder merged 1 commit intomainfrom
docs/setup-instructions

Conversation

@jeremyeder
Copy link
Collaborator

Summary

  • Add Development Setup section to README.md with clone/setup commands and prerequisites
  • Update scripts/setup.sh to:
    • Install pre-commit hooks automatically
    • Check for npm tools (markdownlint, mermaid-cli) and warn if missing
    • Simplify next steps output

Test Plan

  • ./scripts/setup.sh runs successfully
  • pre-commit hooks are installed
  • README setup instructions are accurate

- Add Development Setup section to README.md with prerequisites
- Update setup.sh to install pre-commit hooks automatically
- Add npm tool checks (markdownlint, mermaid-cli) to setup.sh
- Simplify next steps in setup.sh output
@jeremyeder jeremyeder merged commit 920bd48 into main Jan 8, 2026
3 of 4 checks passed
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

Comments