Skip to content

docs: update README, env config, CLAUDE.md, and ROADMAP - #34

Merged
aterrylu merged 2 commits into
mainfrom
terry/docs-update
Mar 16, 2026
Merged

docs: update README, env config, CLAUDE.md, and ROADMAP#34
aterrylu merged 2 commits into
mainfrom
terry/docs-update

Conversation

@aterrylu

Copy link
Copy Markdown
Owner

Summary

  • AUTONOMOS_TOKEN docs: Added auth setup instructions to README and .env.example — how to set, what it does, how the login page works
  • Removed Tailscale: Stripped obsolete Tailscale sidecar references from .env.example (removed in ADR-017)
  • Added deployment docs: DEPLOY_HOST/DEPLOY_PATH in .env.example, remote deployment section in README
  • Updated What's Built: Added recent features — markdown preview, plugin system, settings panel, session persistence, flicker-free rendering, drag reorder
  • Fixed CLAUDE.md: Added missing server/ package to monorepo structure, removed non-existent architecture.md
  • Updated ROADMAP: Marked 12 newly completed items, updated date to 2026-03-15
  • Updated tech stack: xterm.js 6, Mermaid, MCP SDK, PM2

Test plan

  • Verify .env.example has all env vars a new user needs
  • Verify README quick start commands work on a fresh clone
  • Verify CLAUDE.md monorepo structure matches actual directory layout

🤖 Generated with Claude Code

- Add AUTONOMOS_TOKEN auth setup instructions to README and .env.example
- Add deployment section to README
- Remove obsolete Tailscale references from .env.example
- Add DEPLOY_HOST/DEPLOY_PATH to .env.example
- Update What's Built section with recent features (preview, plugins,
  settings, persist, flicker-free rendering)
- Fix CLAUDE.md monorepo structure: add server/, remove architecture.md
- Update ROADMAP.md with all completed items through 2026-03-15
- Update tech stack to reflect xterm.js 6, Mermaid, MCP SDK, PM2

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

@nox-0x nox-0x left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Clean docs housekeeping — auth setup, deployment instructions, and ROADMAP/CLAUDE.md sync all look accurate and well-structured. The .env.example cleanup (Tailscale → AUTONOMOS_TOKEN + DEPLOY_HOST) matches ADR-017. No issues.

- Update scanner error messages from CLAUDE_SESSION_COOKIE to CLAUDE_SESSION_KEY
- Comment out AUTONOMOS_TOKEN in .env.example so cp doesn't enable auth
- Replace personal hostname with generic placeholder in .env.example
- Use cp -n in quick start to avoid overwriting existing .env
- Change "DEC 2026" to "synchronized output" (reads like a date)
- Document DEPLOY_PATH in README remote deployment section

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@aterrylu
aterrylu enabled auto-merge (squash) March 16, 2026 20:57
@aterrylu
aterrylu merged commit 97eb29e into main Mar 16, 2026
1 check passed
@aterrylu
aterrylu deleted the terry/docs-update branch March 16, 2026 20:57
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.

2 participants