Skip to content

docs: update Hyperindex client env var names#130

Open
Kzoeps wants to merge 1 commit intomainfrom
update-hyperindex-env-vars
Open

docs: update Hyperindex client env var names#130
Kzoeps wants to merge 1 commit intomainfrom
update-hyperindex-env-vars

Conversation

@Kzoeps
Copy link
Copy Markdown
Contributor

@Kzoeps Kzoeps commented Apr 21, 2026

Summary

  • rename the client-facing Hyperindex backend env var in the docs to NEXT_PUBLIC_HYPERINDEX_URL
  • document that HYPERINDEX_URL falls back to NEXT_PUBLIC_HYPERINDEX_URL
  • note that Hyperindex normalizes these URLs by trimming whitespace, removing trailing slashes, and adding https:// when needed

Summary by CodeRabbit

  • Documentation
    • Updated environment variable documentation to clarify Hyperindex URL configuration for both client and server environments.
    • Added details on URL normalization behavior, including whitespace trimming and automatic https:// scheme handling.
    • Refreshed deployment instructions for Railway and Next.js setup.

@vercel
Copy link
Copy Markdown
Contributor

vercel bot commented Apr 21, 2026

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

Project Deployment Actions Updated (UTC)
hypercerts-atproto-documentation Ready Ready Preview, Comment Apr 21, 2026 9:05am

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 21, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 88e71325-78f7-48e0-89f8-9da67ed6a016

📥 Commits

Reviewing files that changed from the base of the PR and between a922c63 and 8cd2c76.

📒 Files selected for processing (1)
  • pages/tools/hyperindex.md

📝 Walkthrough

Walkthrough

Documentation update to Hyperindex deployment guide replacing NEXT_PUBLIC_API_URL with NEXT_PUBLIC_HYPERINDEX_URL for browser-side configuration. Clarified server-side fallback behavior and documented URL normalization (whitespace trimming, trailing-slash removal, https defaulting). Updated Railway deployment and troubleshooting sections accordingly.

Changes

Cohort / File(s) Summary
Hyperindex Documentation
pages/tools/hyperindex.md
Renamed browser-side environment variable from NEXT_PUBLIC_API_URL to NEXT_PUBLIC_HYPERINDEX_URL, added documentation for server-side fallback logic and URL normalization behavior, updated Railway deployment instructions and troubleshooting guidance.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

🐰 A rabbit hops through config lines so clear,
Where NEXT_PUBLIC_HYPERINDEX_URL now appears,
No trailing slashes, no whitespace fright,
The docs now glow with brilliant light! ✨

🚥 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 accurately summarizes the main change: updating Hyperindex client environment variable names from NEXT_PUBLIC_API_URL to NEXT_PUBLIC_HYPERINDEX_URL in documentation.
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 update-hyperindex-env-vars

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.

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