Skip to content

docs: reorder portability page and tighten PDS switching section#74

Merged
s-adamantine merged 1 commit into
mainfrom
trim/portability-and-scaling
Mar 5, 2026
Merged

docs: reorder portability page and tighten PDS switching section#74
s-adamantine merged 1 commit into
mainfrom
trim/portability-and-scaling

Conversation

@s-adamantine

@s-adamantine s-adamantine commented Mar 5, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Reordered sections: Public by default → Switching PDSs → Switching apps
  • Tightened PDS switching text (dropped numbered list, added link to ATProto migration guide)

Follow-up to #71.

Fixes HYPER-162

Summary by CodeRabbit

  • Documentation
    • Updated architecture documentation title from "Portability & Scaling" to "Portability & Data Access" across navigation and index pages.
    • Reorganized content to emphasize data access semantics and migration workflows.
    • Streamlined architecture documentation by condensing sections and refocusing narrative on app-switching behavior and data access.

@vercel

vercel Bot commented Mar 5, 2026

Copy link
Copy Markdown
Contributor

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
hypercerts-atproto-documentation Ready Ready Preview, Comment Mar 5, 2026 6:40am
hypercerts-v0.2-documentation Ready Ready Preview, Comment Mar 5, 2026 6:40am

Request Review

@coderabbitai

coderabbitai Bot commented Mar 5, 2026

Copy link
Copy Markdown

Warning

Rate limit exceeded

@s-adamantine has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 20 minutes and 57 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.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: c214e18e-b576-4284-b0e4-39a95e04e2e3

📥 Commits

Reviewing files that changed from the base of the PR and between 8ec0d7e and 20092ec.

📒 Files selected for processing (1)
  • pages/architecture/portability-and-scaling.md
📝 Walkthrough

Walkthrough

Three files updated to rebrand "Portability & Scaling" to "Portability & Data Access" in navigation, index, and documentation. Documentation page undergoes substantial restructuring to emphasize data access semantics and migration workflows while removing detailed scalability sections.

Changes

Cohort / File(s) Summary
Navigation & Index Updates
lib/navigation.js, pages/index.md
Title renamed from "Portability & Scaling" to "Portability & Data Access" in navigation configuration and index card-link, maintaining all other attributes unchanged.
Documentation Content Restructure
pages/architecture/portability-and-scaling.md
Metadata title and description updated to reflect data access focus. Sections heavily reorganized: scalability-focused content (PDS scalability, Indexer scalability, On-chain scalability) removed or collapsed; "Switching PDSs" and "Switching apps" sections condensed with simplified migration narrative; overall net reduction of 31 lines.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Poem

🐰 A name refined, a focus clear,
From scaling heights to data near,
Content trimmed with thoughtful care,
Access semantics fill the air,
Migration paths both swift and fair! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main changes: reordering sections on the portability page and tightening the PDS switching section, which matches the core modifications in all three files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch trim/portability-and-scaling

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.

@s-adamantine s-adamantine force-pushed the trim/portability-and-scaling branch from 1b42659 to 20092ec Compare March 5, 2026 06:39

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

🧹 Nitpick comments (1)
pages/index.md (1)

86-87: Consider aligning the card subtitle with the new “Data Access” framing.

Line 87 still emphasizes “performance,” which reads closer to the old “Scaling” label. A small wording update would keep homepage messaging consistent.

✏️ Suggested copy tweak
-Migration, performance, and privacy
+Migration, app switching, and privacy
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@pages/index.md` around lines 86 - 87, Update the card subtitle inside the {%
card-link %} for "Portability & Data Access": replace the current subtitle text
"Migration, performance, and privacy" with wording that aligns to the new “Data
Access” framing (e.g., "Migration, data access, and privacy" or similar). Locate
the {% card-link title="Portability & Data Access" %} block and edit the inner
text content to the chosen revised subtitle so the homepage messaging is
consistent with the new label.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@pages/index.md`:
- Around line 86-87: Update the card subtitle inside the {% card-link %} for
"Portability & Data Access": replace the current subtitle text "Migration,
performance, and privacy" with wording that aligns to the new “Data Access”
framing (e.g., "Migration, data access, and privacy" or similar). Locate the {%
card-link title="Portability & Data Access" %} block and edit the inner text
content to the chosen revised subtitle so the homepage messaging is consistent
with the new label.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: cbf32672-73f2-4407-89af-93330dde2096

📥 Commits

Reviewing files that changed from the base of the PR and between f948e1d and 8ec0d7e.

📒 Files selected for processing (3)
  • lib/navigation.js
  • pages/architecture/portability-and-scaling.md
  • pages/index.md

@s-adamantine s-adamantine merged commit 4771066 into main Mar 5, 2026
4 checks passed
@s-adamantine s-adamantine deleted the trim/portability-and-scaling branch March 5, 2026 06:42
@coderabbitai coderabbitai Bot mentioned this pull request Mar 5, 2026
aspiers added a commit that referenced this pull request Apr 12, 2026
Link to the /health endpoint on ePDS instances that support it
(currently only epds1.test.certified.app, following ePDS PR #74).

Production and staging instances are marked as old/unversioned
with an upgrade imminent. Vanilla PDS instances (pds1) are marked
n/a since the health endpoint is an ePDS-specific feature.
aspiers added a commit that referenced this pull request Apr 12, 2026
- Split single "Version" column into "ePDS version" and "PDS version"
- ePDS version links to /health (ePDS-specific, from ePDS PR #74)
- PDS version links to /xrpc/_health (standard AT Protocol endpoint)
- Use footnote superscripts to note that prod/staging ePDS instances
  are old/unversioned, and that missing PDS version on ePDS instances
  is a known bug with an imminent fix
- Link to ePDS release notes on GitHub from the version subsection
- Prefix health links with "see" for readability
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