Skip to content

docs: polish READMEs with comprehensive documentation#46

Merged
ascorbic merged 1 commit into
mainfrom
docs/polish-readmes
Jan 3, 2026
Merged

docs: polish READMEs with comprehensive documentation#46
ascorbic merged 1 commit into
mainfrom
docs/polish-readmes

Conversation

@ascorbic
Copy link
Copy Markdown
Owner

@ascorbic ascorbic commented Jan 3, 2026

Summary

  • Main README: Added architecture overview, quick start guide, package table, and status section
  • PDS package README: Comprehensive rewrite with full CLI reference, API endpoint tables, identity/DID documentation, configuration reference, and migration guide
  • Template README: User-facing getting started guide with troubleshooting section

Applied Astro docs style guidelines (neutral tone, direct imperatives, "for example" instead of "e.g." for standalone examples).

Test plan

  • Review rendered markdown on GitHub
  • Verify all links work
  • Check code examples are accurate

🤖 Generated with Claude Code

@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented Jan 3, 2026

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Updated (UTC)
✅ Deployment successful!
View logs
atproto-pds 3dacc78 Jan 03 2026, 09:27 AM

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented Jan 3, 2026

Open in StackBlitz

npm i https://pkg.pr.new/create-pds@46
npm i https://pkg.pr.new/@ascorbic/atproto-oauth-provider@46
npm i https://pkg.pr.new/@ascorbic/pds@46

commit: 3dacc78

- Main README: add architecture overview, quick start, package table
- PDS package: comprehensive CLI reference, endpoint tables, identity/DID docs
- Template README: user-facing getting started guide, troubleshooting

Apply Astro docs style guidelines:
- Neutral, factual tone
- Direct imperatives
- "for example" instead of "e.g." for standalone examples
- Remove unnecessary filler phrases

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@ascorbic ascorbic force-pushed the docs/polish-readmes branch from f5f963c to 3dacc78 Compare January 3, 2026 09:26
@ascorbic ascorbic merged commit 7d629f0 into main Jan 3, 2026
6 checks passed
@ascorbic ascorbic deleted the docs/polish-readmes branch January 3, 2026 13:27
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