docs: v0.7.0 overhaul and migration guide #138

New issue

Closed

opened 2026-09-24 12:39:11 +00:00 by Grandiras · 0 comments

Grandiras commented

2026-09-24 12:39:11 +00:00

Owner

Part of the v0.7.0 update cycle (wave 8). Bring every page in line with the v0.7.0 API and remove duplication.

Migration guide: a new docs/migrating-to-0.7.md covering every breaking change, with before/after snippets (identifiers, sessions, exceptions, DI and packages, OAuth hosting, unions, streaming options, Spaces).
Delete docs/api-reference.md, a hand-written copy of the XML docs that has already drifted, or replace it with a generated one. Fix the pages that link to it for "complete" method lists.
Remove duplicated sections (server/xrpc-handlers, oauth/blazor, aspire/managed-pds, session-management, getting-started, at-protocol-overview, crypto → low-level-repo, error handling repeated in 3 pages). Use links instead.
Every code sample in README.md and docs/ compiles. Consider a docs-snippet test project.
Update CLAUDE.md: architecture, package list, CHANGELOG style rule (one bullet ≤ ~300 chars, no tables or narration), and the stale package job. Update CONTRIBUTING.md (stale three-package layout, issue templates). Decide about .github/skills/issue-workflow/SKILL.md, which says git push origin main.
docs/architecture.md: the current project and folder tree.

Part of the v0.7.0 update cycle (wave 8). Bring every page in line with the v0.7.0 API and remove duplication. - [ ] **Migration guide**: a new `docs/migrating-to-0.7.md` covering every breaking change, with before/after snippets (identifiers, sessions, exceptions, DI and packages, OAuth hosting, unions, streaming options, Spaces). - [ ] Delete `docs/api-reference.md`, a hand-written copy of the XML docs that has already drifted, or replace it with a generated one. Fix the pages that link to it for "complete" method lists. - [ ] Remove duplicated sections (server/xrpc-handlers, oauth/blazor, aspire/managed-pds, session-management, getting-started, at-protocol-overview, crypto → low-level-repo, error handling repeated in 3 pages). Use links instead. - [ ] Every code sample in `README.md` and `docs/` compiles. Consider a docs-snippet test project. - [ ] Update `CLAUDE.md`: architecture, package list, CHANGELOG style rule (one bullet ≤ ~300 chars, no tables or narration), and the stale `package` job. Update `CONTRIBUTING.md` (stale three-package layout, issue templates). Decide about `.github/skills/issue-workflow/SKILL.md`, which says `git push origin main`. - [ ] `docs/architecture.md`: the current project and folder tree.

Grandiras referenced this issue

2026-09-24 12:39:33 +00:00

Tracking: v0.7.0 update cycle — protocol catch-up, optimization, debloat, API reshaping #141

Grandiras referenced this issue

2026-09-25 21:00:33 +00:00

Tracking: v0.7.0 update cycle — protocol catch-up, optimization, debloat, API reshaping #141

Grandiras referenced this issue

2026-09-26 21:36:59 +00:00

refactor(server)!: EF Core package split, no Server dependencies, and an AtProto builder for DI #174

Grandiras referenced this issue

2026-09-26 22:58:25 +00:00

test: store contract tests, EF tests on SQLite, self-provisioning integration CI #176