Skip to content

docs(readme): link each provider row to its per-provider doc#285

Merged
iamtoruk merged 1 commit into
mainfrom
docs/readme-provider-links
May 10, 2026
Merged

docs(readme): link each provider row to its per-provider doc#285
iamtoruk merged 1 commit into
mainfrom
docs/readme-provider-links

Conversation

@iamtoruk
Copy link
Copy Markdown
Member

Summary

  • Replace the Data Location column in the README's Supported Providers table with a Doc column that links to docs/providers/<name>.md (added in docs: contributor guide, architecture map, and per-provider docs #284).
  • The path, storage format, dedup key, and quirks for each provider live in the per-provider doc; the README no longer duplicates a truncated path.
  • Trailing sentence updated to cite the per-provider docs as the source of truth, while keeping the "open an issue" link.

Test plan

  • Render the README on GitHub and confirm every Doc link resolves to its docs/providers/*.md file.
  • Confirm Claude Code and Claude Desktop both link to claude.md (single doc covers both).

The provider table now points each row at its docs/providers/<name>.md
file (added in #284) instead of repeating a one-line path that the
per-provider doc covers in full. The Data Location column is dropped;
the new Doc column links to the markdown that owns the path, storage
format, dedup key, and known quirks.

The trailing sentence is updated to reference the per-provider docs as
the source of truth for data locations.
@iamtoruk iamtoruk merged commit 36c4684 into main May 10, 2026
3 checks passed
@iamtoruk iamtoruk deleted the docs/readme-provider-links branch May 10, 2026 03:46
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