Repository navigation
INTER-2639: docs: render API base URL as code to avoid broken link - #219
Conversation
The base URL was rendered as text that 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
|
pnpm exec changesetto create a changeset. |
There was a problem hiding this comment.
🟢 Approval recommended
All four changes consistently apply the intended documentation-only fix with no unresolved issues.
0 open findings
What changed in this PR
Formats the API base URL as inline code to prevent automatic linking and false broken-link reports, without changing SDK behavior.
Changes:
- Updates both documentation templates.
- Aligns generated documentation with the templates.
| File | Description |
|---|---|
| template/README.solution.mustache | Formats the README base URL as code. |
| template/api_doc.mustache | Formats the API base-path variable as code. |
| README.md | Applies the generated README update. |
| docs/FingerprintApi.md | Applies the generated API documentation update. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
JuroUhlar
changed the title
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, and GitHub auto-links it. It is an API base URL, not a page, so it should be shown as code.Changes
api_doc.mustacheandREADME.solution.mustacherender the base URL as inline code.README.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