Skip to content

Reconcile README with User Guide and fix links broken on the docs site#246

Merged
Cito merged 3 commits into
mainfrom
docs/update-readme-gsi-2498
Jul 14, 2026
Merged

Reconcile README with User Guide and fix links broken on the docs site#246
Cito merged 3 commits into
mainfrom
docs/update-readme-gsi-2498

Conversation

@Cito

@Cito Cito commented Jul 14, 2026

Copy link
Copy Markdown
Member

The README doubles as the landing page of the great-docs site, which caused two problems: repo-relative links (./examples, ./src, ...) resolved on GitHub but 404ed on the site, and the content duplicated large parts of the User Guide.

  • Convert all repo-relative links to absolute GitHub URLs so they work in both contexts (a hidden comment in the README now documents this constraint)
  • Replace the outdated developer-cookbook link with the User Guide's Architectural Concepts chapter
  • Trim the architecture narrative and getting-started sections, deferring depth to the User Guide
  • Move the development-environment and docs-build sections to a new CONTRIBUTING.md, linked from the README
  • Refresh stale content: the protocol/provider table now includes key-value stores and the outbox publisher, and the extras list matches pyproject.toml

@coveralls

coveralls commented Jul 14, 2026

Copy link
Copy Markdown

Coverage Report for CI Build 29341081100

Warning

No base build found for commit c26d86f on main.
Coverage changes can't be calculated without a base build.
If a base build is processing, this comment will update automatically when it completes.

Coverage: 93.325%

Details

  • Patch coverage: No coverable lines changed in this PR.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

Requires a base build to compare against. How to fix this →


Coverage Stats

Coverage Status
Relevant Lines: 3970
Covered Lines: 3705
Line Coverage: 93.32%
Coverage Strength: 0.93 hits per line

💛 - Coveralls

@Cito
Cito requested a review from TheByronHimes July 14, 2026 12:55
TheByronHimes
TheByronHimes previously approved these changes Jul 14, 2026
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Co-authored-by: Byron Himes <thebyronhimes@gmail.com>
@Cito
Cito requested a review from TheByronHimes July 14, 2026 14:30
@Cito
Cito merged commit 252a166 into main Jul 14, 2026
8 checks passed
@Cito
Cito deleted the docs/update-readme-gsi-2498 branch July 14, 2026 14:45
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.

3 participants