Skip to content

docs(universal): Add links to external implementations#35

Merged
thumbrise merged 1 commit into
mainfrom
universal-docs-implementations-links
May 19, 2026
Merged

docs(universal): Add links to external implementations#35
thumbrise merged 1 commit into
mainfrom
universal-docs-implementations-links

Conversation

@thumbrise

@thumbrise thumbrise commented May 19, 2026

Copy link
Copy Markdown
Owner

Summary by CodeRabbit

  • Documentation
    • Added conspicuous stale-content warnings to key documentation to alert readers that information may be outdated.
    • Appended a section with direct links to relevant repositories for the universal schema and HTTP vendor implementations.

Review Change Stack

@coderabbitai

coderabbitai Bot commented May 19, 2026

Copy link
Copy Markdown

Warning

Rate limit exceeded

@thumbrise has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 43 minutes and 19 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ 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.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: bff851f4-f27e-4b3c-8e9a-0fb3ef83e804

📥 Commits

Reviewing files that changed from the base of the PR and between d019be4 and a56bfd4.

📒 Files selected for processing (5)
  • README.md
  • docs/idea.md
  • docs/index.md
  • universal/README.md
  • universal/ROADMAP.md
📝 Walkthrough

Walkthrough

This PR adds collapsible staleness warning blocks to universal/README.md and universal/ROADMAP.md. It also appends an "Appended" section to universal/README.md that lists repository links for universal schema and HTTP universal vendor implementations.

Changes

Documentation updates

Layer / File(s) Summary
Add staleness warnings and repository references
universal/README.md, universal/ROADMAP.md
Both files receive collapsible warning blocks at the top stating content may be stale. README adds an "Appended" section linking to universal schema and HTTP vendor implementation repositories.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

A little rabbit notes: these docs might age,
A folded warning sits upon the page.
An appended table points the curious way,
To moved implementations, bright as day.
🐇✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs(universal): Add links to external implementations' accurately describes the main changes: adding links to external implementations in the universal documentation, with an 'Appended' section containing GitHub links to moved implementations.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch universal-docs-implementations-links

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (2)
universal/README.md (1)

2-7: 💤 Low value

Style: Improve phrasing in warning text.

The phrase "Look at Appended section" would read more naturally as "See the Appended section" or "Refer to the Appended section below."

✨ Suggested improvement
-This content may be stale. Look at Appended section
+This content may be stale. See the Appended section below.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@universal/README.md` around lines 2 - 7, Update the warning text inside the
details/summary block by replacing "Look at Appended section" with a more
natural phrase such as "See the Appended section below" or "Refer to the
Appended section below" (modify the details/summary content where the exact
phrase "Look at Appended section" appears).
universal/ROADMAP.md (1)

3-9: 💤 Low value

Optional: Extra blank line after warning block.

There's an extra blank line (line 9) after the closing </details> tag. This may be intentional spacing, but it's inconsistent with typical markdown formatting around HTML blocks.

🎨 Optional formatting adjustment
 </details>
-
 
 What we plan to build next inside `universal/`. Not a contract. A direction.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@universal/ROADMAP.md` around lines 3 - 9, Remove the extra blank line
following the closing </details> HTML block so the two <details> sections are
consistently spaced; edit the ROADMAP.md content to collapse the stray blank
line after the first </details> and ensure the second <details> block starts
directly on the next line (keep the <details> and <summary> tags intact).
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@universal/README.md`:
- Line 31: Replace the incorrect preposition in the README phrase "moved on
personal repos" with "moved to personal repos"; locate the exact string "moved
on personal repos" in the README.md and update it to "moved to personal repos"
so the sentence reads correctly.

---

Nitpick comments:
In `@universal/README.md`:
- Around line 2-7: Update the warning text inside the details/summary block by
replacing "Look at Appended section" with a more natural phrase such as "See the
Appended section below" or "Refer to the Appended section below" (modify the
details/summary content where the exact phrase "Look at Appended section"
appears).

In `@universal/ROADMAP.md`:
- Around line 3-9: Remove the extra blank line following the closing </details>
HTML block so the two <details> sections are consistently spaced; edit the
ROADMAP.md content to collapse the stray blank line after the first </details>
and ensure the second <details> block starts directly on the next line (keep the
<details> and <summary> tags intact).
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: ffbe8dcd-c729-4aa8-b48c-c4e326e99fe8

📥 Commits

Reviewing files that changed from the base of the PR and between 4175055 and 49441c7.

📒 Files selected for processing (2)
  • universal/README.md
  • universal/ROADMAP.md

Comment thread universal/README.md Outdated
@thumbrise thumbrise force-pushed the universal-docs-implementations-links branch from 49441c7 to d019be4 Compare May 19, 2026 16:00
@thumbrise thumbrise force-pushed the universal-docs-implementations-links branch from d019be4 to a56bfd4 Compare May 19, 2026 16:17
@thumbrise thumbrise merged commit 12cb129 into main May 19, 2026
5 checks passed
@thumbrise thumbrise deleted the universal-docs-implementations-links branch May 19, 2026 16:18
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