Fix: Updated doc link in README.md by smyja · Pull Request #827 · hexclave/stack-auth

smyja · 2025-08-04T04:21:56Z

Fixed broken link

Important

Fix broken link to REST API documentation in README.md.

Documentation:
- Fix broken link to REST API documentation in README.md from https://docs.stack-auth.com/rest-api/overview to https://docs.stack-auth.com/api/overview.

^{This description was created by}^{for 74acf7b. You can customize this summary. It will automatically update as commits are pushed.}

Summary by CodeRabbit

Documentation
- Updated the REST API and setup guide links in the README to the latest URLs.

Fixed broken link

vercel · 2025-08-04T04:22:01Z

@smyja is attempting to deploy a commit to the Stack Team on Vercel.

A member of the Team first needs to authorize it.

CLAassistant · 2025-08-04T04:22:04Z

All committers have signed the CLA.

coderabbitai · 2025-08-04T04:22:07Z

Walkthrough

The README file was updated to modify the URLs for the REST API documentation and the setup guide links. No other content or functionality was changed in the repository.

Changes

Cohort / File(s)	Change Summary
README Update `README.md`	Updated REST API documentation and setup guide links to new URLs.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

A single hop, a tiny tweak,
The docs now point where seekers seek.
No code was changed, no tests to run,
Just clearer trails for everyone.
🐇✨

README’s map now shows the way—
To fresher docs, hooray!

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 74acf7b and b20015e.

📒 Files selected for processing (1)

README.md (1 hunks)

✅ Files skipped from review due to trivial changes (1)

README.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (10)

GitHub Check: restart-dev-and-test
GitHub Check: docker
GitHub Check: check_prisma_migrations (22.x)
GitHub Check: docker
GitHub Check: all-good
GitHub Check: lint_and_build (latest)
GitHub Check: build (22.x)
GitHub Check: build (22.x)
GitHub Check: setup-tests
GitHub Check: Security Check

✨ Finishing Touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

recurseml · 2025-08-04T04:22:30Z

✨ No files to analyze in this PR.

^{Need help? Join our Discord for support!
https://discord.gg/qEjHQk64Z9}

greptile-apps

Greptile Summary

This PR makes a minor documentation update to the main README.md file by correcting a link to Stack Auth's REST API documentation. The change updates the URL from docs.stack-auth.com/rest-api/overview to docs.stack-auth.com/api/overview, which appears to be a URL structure simplification or reorganization on Stack Auth's documentation site.

The modification is straightforward and only affects line 16 of the README, where the REST API reference is mentioned alongside the setup guide link. This type of change is common when documentation sites reorganize their content structure to use shorter, more intuitive URLs. The change ensures users are directed to the current canonical URL rather than potentially deprecated paths, maintaining the quality of the project's documentation links.

Confidence score: 5/5

This PR is extremely safe to merge with no risk of breaking functionality
Score reflects the minimal nature of a single documentation URL update with no code changes
No files require special attention as this is a simple link correction

_{1 file reviewed, no comments}

_{Edit Code Review Bot Settings | Greptile}

madster456 · 2025-08-04T21:38:59Z

Thanks for taking the time to fix this.

I also updated another link there as well. I appreciate it!

Fix: Update doc link

74acf7b

Fixed broken link

greptile-apps Bot reviewed Aug 4, 2025

View reviewed changes

madster456 changed the title ~~Fix: Updated doc link~~ Fix: Updated doc link in README.md Aug 4, 2025

fix setup guide link

b20015e

madster456 self-requested a review August 4, 2025 21:39

madster456 approved these changes Aug 4, 2025

View reviewed changes

N2D4 merged commit ffb720d into hexclave:dev Aug 4, 2025
11 of 18 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix: Updated doc link in README.md#827

Fix: Updated doc link in README.md#827
N2D4 merged 2 commits into
hexclave:devfrom
smyja:patch-1

smyja commented Aug 4, 2025 •

edited by coderabbitai Bot

Loading

Uh oh!

vercel Bot commented Aug 4, 2025

Uh oh!

CLAassistant commented Aug 4, 2025 •

edited

Loading

Uh oh!

coderabbitai Bot commented Aug 4, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

recurseml Bot commented Aug 4, 2025

Uh oh!

greptile-apps Bot left a comment

Uh oh!

madster456 commented Aug 4, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

smyja commented Aug 4, 2025 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

vercel Bot commented Aug 4, 2025

Uh oh!

CLAassistant commented Aug 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot commented Aug 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

recurseml Bot commented Aug 4, 2025

Uh oh!

greptile-apps Bot left a comment

Choose a reason for hiding this comment

Greptile Summary

Confidence score: 5/5

Uh oh!

madster456 commented Aug 4, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

smyja commented Aug 4, 2025 •

edited by coderabbitai Bot

Loading

CLAassistant commented Aug 4, 2025 •

edited

Loading

coderabbitai Bot commented Aug 4, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)