docs: thin out README by moving detailed tables to docs

[strawgate]

Summary

This PR thins out the README by moving detailed tables to the documentation site, reducing duplication while maintaining a good overview.

Changes

• ✨ Created comprehensive docs/stores.md with all store information
• ✨ Added summary tables to docs/wrappers.md and docs/adapters.md
• ✨ Added DataclassAdapter documentation to adapters.md
• 📝 Updated README to have concise overviews with links to full docs
• 📝 Updated mkdocs.yml navigation to include stores.md

Benefits

1. Better Maintainability: Tables only exist in one place (docs)
2. Clearer Navigation: README provides overview, docs have details
3. More Context: Store docs include use cases, characteristics, and guidance
4. Complete Coverage: Added missing DataclassAdapter documentation

Closes #172

Generated with Claude Code) | View branch | [View job run](https://github.com/strawgate/py-key-value/actions/runs/18895102494

Summary by CodeRabbit

• Documentation
  • Updated documentation links to new domain
  • Reorganized documentation sections for improved clarity and navigation
  • Added comprehensive Stores documentation including classifications, stability ratings, and usage guidance
  • Enhanced Adapters and Wrappers documentation with detailed sections and examples
  • Expanded documentation navigation menu with Stores entry

[coderabbitai]

Warning

Rate limit exceeded

@strawgate has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 11 minutes and 15 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 2de7e1c and 65da711.

📒 Files selected for processing (1)

• docs/stores.md (1 hunks)

📝 Walkthrough

Walkthrough

Documentation restructuring to enhance clarity and organization: README.md links updated to new domain, sections reorganized (Stores, Stability, Adapters, Wrappers); new comprehensive stores documentation added; adapters and wrappers documentation restructured with detailed sections; mkdocs navigation updated.

Changes

Cohort / File(s)	Change Summary
README.md	Updated documentation domain links; reorganized Stores, Stability, Adapters, and Wrappers sections with simplified descriptions and category-based organization; removed detailed tables in favor of concise explanations and links
Documentation Structure docs/adapters.md, docs/wrappers.md	Restructured adapter and wrapper documentation with new "Details" sections; added adapter listing table; added Available Wrappers table; replaced prior list-based index format
New Stores Documentation docs/stores.md	New comprehensive file categorizing stores into Local, Secret, and Distributed with stability levels; includes individual store subsections with code samples, installation details, use cases, and characteristics
Navigation Configuration mkdocs.yml	Added top-level "Stores" navigation entry linking to stores.md

Possibly related PRs

• docs: fix documentation issues #141: Modifies wrapper documentation structure and listings similarly to this PR's wrappers.md restructuring
• Add comprehensive MkDocs documentation for wrappers and adapters #128: Modifies the same documentation files (README.md, mkdocs.yml, docs/adapters.md, docs/wrappers.md) for API documentation organization

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The pull request title "docs: thin out README by moving detailed tables to docs" accurately captures the primary objective of this changeset. The changes demonstrate this core purpose: the README.md has been reorganized with concise overviews and documentation links, while detailed tables and extended content have been moved to dedicated documentation files (docs/stores.md, docs/wrappers.md, docs/adapters.md). The title is specific, clear, and avoids vague terminology, making it immediately understandable to someone scanning the project history.
Linked Issues Check	✅ Passed	The PR addresses the linked issue #172 ("Readme review") by fixing documentation accuracy and organization. The changes update documentation links from strawgate.github.io to strawgate.com as requested in the PR comments, ensuring links point to the correct public documentation site. The reorganization consolidates detailed information into properly structured documentation files, which improves documentation clarity and maintainability prior to release. While the linked issue broadly requests reviewing readme, agents, and developing docs, the PR demonstrates attention to documentation accuracy through link corrections and reorganization, with the PR description indicating this work is part of addressing that broader review objective.
Out of Scope Changes Check	✅ Passed	All changes in the pull request are aligned with the stated PR objectives. The modifications consist entirely of documentation reorganization and enhancement: updating README.md with links to detailed docs, adding comprehensive docs/stores.md file, enhancing docs/adapters.md and docs/wrappers.md with better structure and the new DataclassAdapter documentation, and updating mkdocs.yml navigation. These changes directly support the primary purpose of reducing README size while maintaining comprehensive documentation elsewhere. No unrelated code changes, refactoring, or feature additions are present in this changeset.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[strawgate]

@claude please run lint also our docs are hosted on https://strawgate.com/py-key-value/ so the readme should link to either our public docs or to the markdown files for the sections, i think the readme is just pointing people at folders of code at the moment

[claude]

Claude finished @strawgate's task —— View job

---

Completed Successfully! ✅

Tasks

• Get project context and PR details
• Read README.md to identify link issues
• Run make lint
• Fix README links to point to public docs
• Fix markdown lint errors in docs/wrappers.md
• Commit and push changes
• Run lint again to verify

Changes Made

README.md:

• ✅ Updated all documentation links from strawgate.github.io to strawgate.com (lines 11-15)
• ✅ Updated store documentation link (line 199)
• ✅ Updated adapters documentation link (line 212)
• ✅ Updated wrappers documentation link (line 266)
• ✅ Replaced project links section to point to public docs instead of subdirectory README files (lines 356-357)

docs/wrappers.md:

• ✅ Removed invalid link fragments (CollectionRoutingWrapper, DefaultValueWrapper, RoutingWrapper) that pointed to non-existent sections
• ✅ Fixed duplicate "Available Wrappers" heading by renaming the second one to "Wrapper Details"
• ✅ Reordered wrapper table to match the order they appear in the document

Verification

• ✅ All lint checks pass (make lint)
• ✅ Python files formatted correctly
• ✅ Markdown files formatted correctly
• ✅ All links now point to public documentation at strawgate.com

The changes have been committed and pushed to the branch claude/issue-172-20251029-0224.

---

|

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud