fix: add .html extensions to documentation links

[strawgate]

Fixes broken documentation links in README.md that were pointing to directory-style URLs without .html extensions. The MkDocs site requires .html extensions for all documentation pages.

Changes

• Getting Started Guide: getting-started/ → getting-started.html
• Wrappers Guide: wrappers/ → wrappers.html
• Adapters Guide: adapters/ → adapters.html
• API Reference (2 locations): api/protocols/ → api/protocols.html

Fixes #182

Generated with Claude Code

Summary by CodeRabbit

• Documentation
  • Updated documentation links to point to HTML pages for Getting Started, Wrappers, Adapters, and API Reference sections.

[coderabbitai]

📝 Walkthrough

Walkthrough

The README.md file has been updated to correct documentation hyperlinks. Links to Getting Started, Wrappers, Adapters, and API Reference pages now properly point to their .html file paths on the website instead of non-.html page paths.

Changes

Cohort / File(s)	Summary
Documentation link corrections README.md	Updated four hyperlinks to append .html extensions: Getting Started, Wrappers, Adapters, and API Reference links now reference the correct file paths

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 "fix: add .html extensions to documentation links" directly and clearly summarizes the main change in the changeset. The title is concise, specific, and accurately reflects the primary objective of updating README.md links to include .html extensions so they resolve correctly on the MkDocs site. A teammate scanning the history would immediately understand this is about fixing documentation link formatting.
Linked Issues Check	✅ Passed	The code changes directly address the objectives from issue #182. The PR updates README.md links from directory-style URLs to .html equivalents, which aligns with the requirements to identify and fix broken links that point to site pages without .html extensions. The specific changes documented in the PR (Getting Started, Wrappers, Adapters, and API Reference links) match the objectives of updating links to resolve correctly on the MkDocs site.
Out of Scope Changes Check	✅ Passed	All changes in this pull request are directly scoped to the objectives outlined in issue #182. The modifications are limited to updating hyperlinks in README.md from non-.html paths to .html-based URLs. The raw summary confirms that only URL targets were changed with no functional, behavioral, control-flow, or error-handling modifications, and there are no alterations to exported or public entity declarations. These are targeted documentation link corrections with no extraneous changes.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch claude/issue-182-20251030-2048

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8ecc042 and 6550e4f.

📒 Files selected for processing (1)

• README.md (2 hunks)

🔇 Additional comments (3)

README.md (3)

12-15: Documentation links properly updated with .html extensions.

The links in the main Documentation section have been correctly updated from directory-style URLs to their .html equivalents, aligning with MkDocs site requirements.

---

199-199: Verify link format consistency for related documentation references.

The PR updates documentation links in the main links section (lines 12-15) to use .html extensions, but similar links elsewhere in the document still use directory-style URLs:

• Line 199: stores/ (not updated)
• Line 212: adapters/ (not updated, while line 14 updated to adapters.html)
• Line 266: wrappers/ (not updated, while line 13 updated to wrappers.html)

Confirm whether these secondary reference links should also be converted to .html for consistency, or whether the MkDocs site configuration redirects directory-style URLs to their .html equivalents.

Also applies to: 212-212, 266-266

---

357-357: API Reference link in footer correctly updated.

The second instance of the API Reference link (in Project links) has been properly updated from api/protocols/ to api/protocols.html, matching the update at line 15.

---

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

[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