docs: fix dead API Documentation badge link (localhost -> #api-usage) - #355
Merged
Conversation
The header "API Documentation" badge linked to http://localhost:8000/docs/, which is a dead link for anyone reading the README on GitHub (the Swagger UI only exists at runtime on a local instance). Point it at the README's "API Usage" section instead. The localhost URLs in the service-access table and usage examples are correct and left unchanged. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
The header API Documentation badge linked to
http://localhost:8000/docs/— a dead link for anyone reading the README on GitHub (the Swagger UI only exists at runtime on a running instance).Fix
Point the badge at the README's API Usage section (a real, public, in-repo destination). The
localhost:8000URLs elsewhere (service-access table,curlusage examples) correctly describe the locally-running service and are left unchanged.🤖 Generated with Claude Code