Repository navigation
docs: rewrite pages with the technical-writer skill and adopt project-template conventions - #49
Merged
Merged
Conversation
…-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
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
reconcileandplando not have. There was no troubleshooting page. The repo was also missing conventions thatvercel-labs/project-templatenow ships.Changes
technical-writerskill. Each claim was checked againstsrc/and command help; pinned test strings and linked anchors are unchangedstatusandlinear, Linear setup, rejected Linear sessions, Linear rate limits, andquerywithout a saved model. Error strings are quoted fromsrc/issue-graph/transport/linearexport and the Linear collectorslinear loginstores its sessionlinearexamplesapps/docs/AGENTS.mdandCLAUDE.md, whichnext devwrites on every runAGENTS.mdwith the writing, generated-file, and release recovery rulesVisual proof
The new Troubleshooting page in the docs navigation.