docs: Add table of contents and remove ngrok references #28
Conversation
vhrahulkumar
commented
Feb 4, 2026
vhrahulkumar
commented
- Add table of contents to README
- Remove all ngrok references from documentation
- Update deployment stages: CLI-only (Stage 1) and Tailscale (Stage 2)
- Update CHEATSHEET.md, CLAUDE.md, and AI-ASSISTED-SETUP.md
- Add table of contents to README - Remove all ngrok references from documentation - Update deployment stages: CLI-only (Stage 1) and Tailscale (Stage 2) - Update CHEATSHEET.md, CLAUDE.md, and AI-ASSISTED-SETUP.md
…ames - Update README.md and AI-ASSISTED-SETUP.md - Replace 'Stage 1: CLI Only' with 'CLI Only - The Basics' - Replace 'Stage 2: Production with Tailscale' with 'Production with Tailscale' - Update 'Adding Persistence (Any Stage)' to just 'Adding Persistence' - Makes deployment options clearer
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation to simplify the deployment model by removing ngrok references and reorganizing around two core deployment stages: CLI-only access and production with Tailscale.
Changes:
- Added a table of contents to README.md for improved navigation
- Removed all ngrok-related documentation and references
- Restructured deployment stages from three options (CLI, ngrok, Tailscale) to two (CLI Only, Production with Tailscale)
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Added table of contents, removed ngrok stage and references, updated deployment table and architecture diagram |
| CLAUDE.md | Removed ngrok from service restart examples |
| CHEATSHEET.md | Removed ngrok service restart commands and process filtering |
| AI-ASSISTED-SETUP.md | Removed Stage 2 (ngrok) section, updated deployment mode references |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
- Remove ngrok section and troubleshooting from CHEATSHEET.md - Remove ngrok service reference from CLAUDE.md - Remove ENABLE_NGROK from CONTRIBUTING.md examples and table - Update tests/CLAUDE.md to remove ngrok mention
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
1 participant
