Skip to content

docs: README links conventions instead of restating the write tier - #40

Merged
bvalosek merged 1 commit into
mainfrom
docs/readme-link-conventions
Sep 9, 2026
Merged

docs: README links conventions instead of restating the write tier#40
bvalosek merged 1 commit into
mainfrom
docs/readme-link-conventions

Conversation

@bvalosek

@bvalosek bvalosek commented Sep 9, 2026

Copy link
Copy Markdown
Member

Summary

  • The README restated the write-tier (jti, 409, body discipline), optional-auth, and identity-proof semantics nearly line for line with no link to the canonical reference. Each is now one sentence plus a link to the matching section of https://docs.dfos.com/docs/api/conventions (#optional-authentication, #writing, #reading-your-own-data-needs-no-credential; all verified live).
  • What the package itself does stays: createApiAuthFetch and its jti option values, the @metalabel/dfos-client/api-auth symbols.
  • protocol.dfos.com/siwd and /api-auth are retired slugs that meta-refresh to a fixed anchor and drop fragments; links now point at https://protocol.dfos.com/integrations#sign-in, #api-authentication, and #advertising-in-openapi.

206 → 183 lines. No code, no spec, no generated types touched.

Test plan

  • pnpm lint (prettier) clean on README.md; pnpm typecheck green.
  • Every link curl-verified 200 with the anchor present.

🤖 Generated with Claude Code

https://claude.ai/code/session_014DSivq7w9bFUQYWoRgTtn5

…antics to docs.dfos.com conventions; repoint retired protocol.dfos.com slugs

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014DSivq7w9bFUQYWoRgTtn5
@bvalosek
bvalosek merged commit 32bbdf3 into main Sep 9, 2026
1 check passed
@bvalosek
bvalosek deleted the docs/readme-link-conventions branch September 9, 2026 04:01
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