Skip to content

docs: add ReDoc URL to README#20

Open
ilysenko wants to merge 1 commit into
mainfrom
docs/readme-add-redoc-url
Open

docs: add ReDoc URL to README#20
ilysenko wants to merge 1 commit into
mainfrom
docs/readme-add-redoc-url

Conversation

@ilysenko
Copy link
Copy Markdown
Owner

Adds the ReDoc URL alongside the Swagger UI URL in the README. FastAPI exposes ReDoc by default at /redoc; this just documents it.

Single-line README addition. No code changes.

@ilysenko ilysenko added the autoreview/risk-trivial Bot judged risk as trivial (docs/typos/format) label May 11, 2026
Copy link
Copy Markdown
Owner Author

@ilysenko ilysenko left a comment

Choose a reason for hiding this comment

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

Review Mate: merge recommended

🟢 Recommendation: merge recommended
Risk level: trivial

This looks safe to merge after the usual maintainer checks.

Automation: The bot did not merge because auto-merge is disabled for this project.

This PR documents FastAPI's default ReDoc route alongside the existing Swagger UI and healthcheck links. The change is README-only and does not affect the application runtime contract.

What changed

  • README.md adds a ReDoc link under the local run instructions.

Why it matters

The touched file is documentation only, with no changes to API schemas, routers, storage, tests, packaging, or CI. No new tests are needed for this kind of change.

Notes for the reviewer

Local verification commands could not start in this read-only sandbox because the command runner failed before reading files; this judgment is based on the supplied PR diff.

References

  • README.md:31

@ilysenko
Copy link
Copy Markdown
Owner Author

hjghkhjk

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

autoreview/risk-trivial Bot judged risk as trivial (docs/typos/format)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants