Skip to content

docs: rewrite pages with the technical-writer skill and adopt project-template conventions - #49

Merged
Railly merged 1 commit into
mainfrom
railly/docs-technical-writer
Nov 7, 2026
Merged

Railly merged 1 commit into
mainfrom
railly/docs-technical-writer

Conversation

@Railly

@Railly Railly commented Nov 7, 2026

Copy link
Copy Markdown
Member

Problem

The docs pages carried filler, passive phrasing, and a few stale facts: Library and Security predate the Linear provider, and Reference pointed to per-command help that reconcile and plan do not have. There was no troubleshooting page. The repo was also missing conventions that vercel-labs/project-template now ships.

Changes

  • Rewrite every docs page with the technical-writer skill. Each claim was checked against src/ and command help; pinned test strings and linked anchors are unchanged
  • Add a Troubleshooting page: GitHub sign-in, exit code 1 from status and linear, Linear setup, rejected Linear sessions, Linear rate limits, and query without a saved model. Error strings are quoted from src/
  • Correct stale facts:
    • Library lists the issue-graph/transport/linear export and the Linear collectors
    • Security covers Linear access and where linear login stores its session
    • Reference lists the commands with their own help and adds linear examples
    • Linear no longer says rate-limited captures never retry
  • From project-template:
    • Commit apps/docs/AGENTS.md and CLAUDE.md, which next dev writes on every run
    • Add a PR template
    • Extend AGENTS.md with the writing, generated-file, and release recovery rules

Visual proof

The new Troubleshooting page in the docs navigation.

Troubleshooting page

…-template conventions

- Rewrite every docs page for plain, verified wording; add a Troubleshooting page
- Correct stale facts: Linear transport and collectors in Library, Linear session storage in Security, per-command help in Reference
- Commit the docs agent files that next dev writes, add a PR template, and extend AGENTS.md with the template's writing, generated-file, and release rules
@vercel

vercel Bot commented Nov 7, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
issue-graph Ready Ready Preview, v0 Nov 7, 2026 7:33pm UTC

@Railly
Railly merged commit c0d6850 into main Nov 7, 2026
12 checks passed
@Railly
Railly deleted the railly/docs-technical-writer branch November 7, 2026 19:37

This branch was successfully deployed

1 active deployment
Preview — 8ad8d356 Deployed Nov 7, 2026 by vercel[bot]
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