feat(api): Fix API reference tag-based section template #6686
Conversation
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
Contributor
|
jstirnaman
changed the title
jstirnaman
changed the title
The previous commit added an .IsSection check that correctly fixed section index pages but inadvertently broke endpoint pages that Hugo classifies as sections. This commit refines the conditional to check for the absence of the staticFilePath parameter, which distinguishes true section index pages from endpoint pages that need the RapiDoc renderer: - Section pages (no staticFilePath): Show children listing - Endpoint pages (with staticFilePath): Use RapiDoc renderer Fixes the regression introduced in commit 59daf17.
Update code comments and documentation to accurately reflect that the API documentation uses RapiDoc, not Scalar: - api-docs/scripts/generate-openapi-articles.ts: Update JSDoc comments - api-docs/scripts/dist/generate-openapi-articles.js: Update compiled version - assets/js/components/api-toc.ts: Update implementation comment - .claude/agents/ts-component-dev.md: Update component reference - .claude/skills/hugo-template-dev/SKILL.md: Update component reference The implementation uses RapiDoc throughout, so these comments needed to be corrected for accuracy.
jstirnaman
force-pushed
the
claude/fix-docs-build-issue-VL3Et
branch
from
c3e6597 to
a3648a7
Compare
jstirnaman
added a commit
that referenced
this pull request
Jan 2, 2026
* fix(api): refine .IsSection check to prevent breaking endpoint pages The previous commit added an .IsSection check that correctly fixed section index pages but inadvertently broke endpoint pages that Hugo classifies as sections. This commit refines the conditional to check for the absence of the staticFilePath parameter, which distinguishes true section index pages from endpoint pages that need the RapiDoc renderer: - Section pages (no staticFilePath): Show children listing - Endpoint pages (with staticFilePath): Use RapiDoc renderer Fixes the regression introduced in commit 59daf17. * chore: update Scalar references to RapiDoc in comments Update code comments and documentation to accurately reflect that the API documentation uses RapiDoc, not Scalar: - api-docs/scripts/generate-openapi-articles.ts: Update JSDoc comments - api-docs/scripts/dist/generate-openapi-articles.js: Update compiled version - assets/js/components/api-toc.ts: Update implementation comment - .claude/agents/ts-component-dev.md: Update component reference - .claude/skills/hugo-template-dev/SKILL.md: Update component reference The implementation uses RapiDoc throughout, so these comments needed to be corrected for accuracy. --------- Co-authored-by: Claude <noreply@anthropic.com>
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.
Fix tag-based API reference sub section pages template. Adds a condition to check for presence of a spec file to differentiate from the parent section page.