Review docs links

[strawgate]

Let's review docs links, I think we might be missing a link to the stores docs for example

[claude]

Claude finished @strawgate's task —— View job

---

Documentation Link Review Complete ✓

tl;dr

The README.md is missing a link to the Stores documentation. The docs/index.md correctly includes a link to stores.md in the "Quick Links" section, but the main README.md (lines 9-15) only references Getting Started, Wrappers, Adapters, and API Reference—stores.md is completely absent.

---

Recommendation

Add a link to the Stores documentation in README.md line 13 (between Getting Started and Wrappers) to match the navigation structure in mkdocs.yml and the Quick Links in docs/index.md.

The link should be:

- [Stores Guide](https://strawgate.com/py-key-value/stores.html)

This would make the README's documentation section complete and align it with:

1. The mkdocs.yml navigation structure (line 70: - Stores: stores.md)
2. The docs/index.md Quick Links section (line 22-25)
3. The pattern established by issue Broken links in readme #182 where .html extensions are required

---

Findings

Current Documentation Links in README.md

Lines 9-15 contain the "Documentation" section:

• ✅ Full Documentation: https://strawgate.com/py-key-value/
• ✅ Getting Started Guide: https://strawgate.com/py-key-value/getting-started.html
• ❌ Stores Guide: MISSING
• ✅ Wrappers Guide: https://strawgate.com/py-key-value/wrappers.html
• ✅ Adapters Guide: https://strawgate.com/py-key-value/adapters.html
• ✅ API Reference: https://strawgate.com/py-key-value/api/protocols.html

Documentation Links in docs/index.md

Lines 20-25 contain the "Quick Links" section:

• ✅ Getting Started: getting-started.md
• ✅ Wrappers: wrappers.md
• ✅ Adapters: adapters.md
• ❌ Stores: MISSING from this list too (but referenced in line 11 in the overview)
• ✅ API Reference: api/protocols.md

Actually, upon closer inspection, docs/index.md also doesn't have stores in its Quick Links section, even though stores.md exists and is in the mkdocs.yml navigation!

MkDocs Navigation Structure (mkdocs.yml)

Lines 67-78 define the complete navigation:

• Home: index.md
• Getting Started: getting-started.md
• Stores: stores.md ← This exists in navigation
• Wrappers: wrappers.md
• Adapters: adapters.md
• API Reference (with 4 subsections)

stores.md File

The file exists at /home/runner/work/py-key-value/py-key-value/docs/stores.md and contains comprehensive documentation about:

• Local Stores (Memory, Disk, RocksDB, etc.)
• Secret Stores (Keyring, Vault)
• Distributed Stores (Redis, Valkey, DynamoDB, Elasticsearch, MongoDB, Memcached)
• Stability levels
• Store selection guidance

This is substantial content (622 lines) that deserves to be prominently linked!

README.md Line 199

Interestingly, README.md line 199 does reference stores:

**[📚 View all stores, installation guides, and examples →](https://strawgate.com/py-key-value/stores/)**

However, this link has a trailing slash (stores/ instead of stores.html), which may not work correctly based on issue #182 where trailing slashes were removed in favor of .html extensions.

Detailed Action Plan

Step 1: Update README.md Documentation Section

Add the missing Stores Guide link in the Documentation section (after line 12):

## Documentation

- [Full Documentation](https://strawgate.com/py-key-value/)
- [Getting Started Guide](https://strawgate.com/py-key-value/getting-started.html)
- [Stores Guide](https://strawgate.com/py-key-value/stores.html)
- [Wrappers Guide](https://strawgate.com/py-key-value/wrappers.html)
- [Adapters Guide](https://strawgate.com/py-key-value/adapters.html)
- [API Reference](https://strawgate.com/py-key-value/api/protocols.html)

Step 2: Fix README.md Line 199

Update the trailing slash to use .html extension for consistency:

Change:

**[📚 View all stores, installation guides, and examples →](https://strawgate.com/py-key-value/stores/)**

To:

**[📚 View all stores, installation guides, and examples →](https://strawgate.com/py-key-value/stores.html)**

Step 3: Update docs/index.md Quick Links (Optional but Recommended)

Add Stores to the Quick Links section in docs/index.md (after line 22):

## Quick Links

- [Getting Started](getting-started.md) - Installation and basic usage
- [Stores](stores.md) - Detailed documentation for all stores
- [Wrappers](wrappers.md) - Detailed documentation for all wrappers
- [Adapters](adapters.md) - Detailed documentation for all adapters
- [API Reference](api/protocols.md) - Complete API documentation

Related Items

Related Issues and Pull Requests

Repository	Issue or PR	Relevance
strawgate/py-key-value	Issue #182: Broken links in readme	Fixed documentation links to use .html extensions instead of trailing slashes; establishes the pattern for correct link format
strawgate/py-key-value	PR #183: fix: add .html extensions to documentation links	Merged PR that fixed documentation link format, confirming that .html extensions are required
strawgate/py-key-value	Issue #124: More detailed documentation	Created the initial docs/ folder structure including stores.md
strawgate/py-key-value	Issue #172: Readme review	Comprehensive documentation review that thinned out README and moved detailed tables to dedicated docs files including stores.md
strawgate/py-key-value	PR #179: docs: thin out README by moving detailed tables to docs	Created stores.md and moved store details from README, but may have missed adding the link back to README

Related Files

Repository	File	Relevance	Lines
strawgate/py-key-value	README.md	Main repository README with the incomplete documentation links section	9-15, 199
strawgate/py-key-value	docs/index.md	Documentation homepage that also has incomplete Quick Links	20-25
strawgate/py-key-value	docs/stores.md	The comprehensive stores documentation that needs to be linked	Full file (622 lines)
strawgate/py-key-value	mkdocs.yml	MkDocs configuration showing the correct navigation structure that includes stores.md	67-78

---

Problems Encountered During Investigation

None - all investigation tools and resources were accessible and provided comprehensive information.

---

[strawgate]

@claude PR please

[claude]

Claude finished @strawgate's task —— View job • claude/issue-189-20251101-1757 • Create PR ➔

---

Documentation Links Fix Complete ✓

Todo List

• Get project overview
• Read repository guidelines (CLAUDE.md)
• Review current README.md and docs/index.md
• Add missing Stores Guide link to README.md
• Fix trailing slash in README.md line 199
• Update docs/index.md Quick Links
• Run linting
• Commit and push changes
• Provide PR creation link

Summary

Fixed the missing Stores documentation links identified in the initial analysis:

1. README.md line 13: Added [Stores Guide](https://strawgate.com/py-key-value/stores.html) to the Documentation section, positioned between Getting Started and Wrappers to match the mkdocs.yml navigation structure
2. README.md line 200: Fixed trailing slash from stores/ to stores.html to align with the pattern established in issue Broken links in readme #182
3. docs/index.md line 23: Added [Stores](stores.md) to the Quick Links section

All three documentation entry points now correctly reference the stores.md documentation, making it discoverable alongside the other guide pages.

---

Problems Encountered

• Linting: Unable to run make lint due to missing dependencies (ruff not installed in the CI environment). This should be handled by the CI pipeline when the PR is created.

---

| Branch