Skip to content

Improve docs information architecture#51

Merged
adnaan merged 1 commit into
mainfrom
docs-quality-roadmap-impl
Jun 1, 2026
Merged

Improve docs information architecture#51
adnaan merged 1 commit into
mainfrom
docs-quality-roadmap-impl

Conversation

@adnaan
Copy link
Copy Markdown
Contributor

@adnaan adnaan commented Jun 1, 2026

Summary

  • add a getting-started mental model page for templates, controllers, state, transports, and pub/sub
  • reorganize sidebar navigation into Start, Build, Patterns, Apps, Deploy, Reference, CLI, and Client sections
  • add homepage comparison/fit guidance and consistent transport wording
  • add at-a-glance tables to long reference pages and descriptions to high-traffic docs
  • add GOWORK=off test targets, including local e2e, plus README guidance
  • document client CDN versioning guidance

Paired tinkerdown PR

Validation

  • go run /home/adnaan/code/livetemplate/tinkerdown/cmd/tinkerdown validate content/ -> 56 valid, 0 errors
  • make test-unit
  • make test-examples
  • GOWORK=off E2E_BASE_URL=http://127.0.0.1:8084 go test ./e2e/... -count=1

Preview

@adnaan adnaan merged commit 4ee00fa into main Jun 1, 2026
2 checks passed
@adnaan adnaan deleted the docs-quality-roadmap-impl branch June 1, 2026 21:46
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