Repository navigation
INTER-2639: docs: render API base URL as code to avoid broken link - #243
Merged
Merged
Conversation
The base URL was rendered as italic text, which GitHub auto-links to a 404 page. Use inline code instead. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01D8bTHvDMspvza23W9oMRYJ
JuroUhlar
requested review from
TheUnderScorer,
erayaydin and
ilfa
as code owners
October 15, 2026 09:40
Contributor
☂️ Code Coverage
Overall Coverage
New FilesNo new covered files... Modified FilesNo covered modified files...
|
Contributor
pnpm exec changesetto create a changeset. |
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
All six changes consistently apply the intended documentation formatting without affecting SDK behavior.
0 open findings
What changed in this PR
Renders the API base URL as inline code to prevent automatic linking to a non-page endpoint, without changing SDK behavior.
Changes:
- Updates three documentation templates to use inline code.
- Synchronizes generated documentation with the templates.
| File | Description |
|---|---|
| template/common_README.mustache | Formats the README base URL as code. |
| template/common_README_pypi.mustache | Formats the PyPI base URL as code. |
| template/api_doc.mustache | Uses inline code and unescaped URL interpolation. |
| README.pypi.md | Updates generated PyPI documentation. |
| README.md | Updates the generated README. |
| docs/FingerprintApi.md | Updates generated API documentation. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This was referenced Oct 15, 2026
Merged
erayaydin
approved these changes
Oct 15, 2026
JuroUhlar
changed the title
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
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.
Summary
The docs-link-checker reports
https://api.fpjs.io/v4as a broken link (HTTP 404) in the README. The base URL is written as italic text (*{{basePath}}*), and GitHub auto-links it. The URL is an API base path, not a page, so it should be shown as code.Changes
api_doc.mustache,common_README.mustacheandcommon_README_pypi.mustachenow render the base URL as inline code. They use{{{basePath}}}so the URL is not HTML-escaped.README.md,README.pypi.mdanddocs/FingerprintApi.mdare updated to match.No changeset: docs only, no SDK behavior change.
Jira: INTER-2639
🤖 Generated with Claude Code
https://claude.ai/code/session_01D8bTHvDMspvza23W9oMRYJ