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.
claude/fix-docs-build-issue-VL3Et
Claude 2026-01-02 01:48:06 +00:00
parent fd0bb98155
commit a3648a79a4
No known key found for this signature in database
5 changed files with 7 additions and 7 deletions

View File

@ -197,7 +197,7 @@ assets/js/
│ ├── api-nav.ts # API navigation behavior
│ ├── api-toc.ts # Table of contents
│ ├── api-tabs.ts # Tab switching
│ └── api-scalar.ts # Scalar/RapiDoc integration
│ └── api-rapidoc.ts # RapiDoc integration
└── utils/
├── dom-helpers.ts # Shared DOM utilities
└── debug-helpers.js # Debugging utilities

View File

@ -345,7 +345,7 @@ assets/
│ │ ├── api-nav.ts # API navigation behavior
│ │ ├── api-toc.ts # Table of contents
│ │ ├── api-tabs.ts # Tab switching (if needed beyond CSS)
│ │ └── api-scalar.ts # Scalar/RapiDoc integration
│ │ └── api-rapidoc.ts # RapiDoc integration
│ └── utils/
│ └── dom-helpers.ts # Shared DOM utilities
└── styles/

View File

@ -131,7 +131,7 @@ function generateDataFromOpenAPI(specFile, dataOutPath, articleOutPath) {
* Generate Hugo content pages from article data
*
* Creates markdown files with frontmatter from article metadata.
* Each article becomes a page with type: api that renders via Scalar.
* Each article becomes a page with type: api that renders via RapiDoc.
*
* @param options - Generation options
*/
@ -488,7 +488,7 @@ ${yaml.dump(frontmatter)}---
const productConfigs = {
// TODO: v2 products (cloud-v2, oss-v2) are disabled for now because they
// have existing Redoc-based API reference at /reference/api/
// Uncomment when ready to migrate v2 products to Scalar
// Uncomment when ready to migrate v2 products to RapiDoc
// 'cloud-v2': {
// specFile: path.join(API_DOCS_ROOT, 'influxdb/cloud/v2/ref.yml'),
// pagesDir: path.join(DOCS_ROOT, 'content/influxdb/cloud/api'),

View File

@ -159,7 +159,7 @@ interface GeneratePagesOptions {
* Generate Hugo content pages from article data
*
* Creates markdown files with frontmatter from article metadata.
* Each article becomes a page with type: api that renders via Scalar.
* Each article becomes a page with type: api that renders via RapiDoc.
*
* @param options - Generation options
*/
@ -689,7 +689,7 @@ ${yaml.dump(frontmatter)}---
const productConfigs: ProductConfigMap = {
// TODO: v2 products (cloud-v2, oss-v2) are disabled for now because they
// have existing Redoc-based API reference at /reference/api/
// Uncomment when ready to migrate v2 products to Scalar
// Uncomment when ready to migrate v2 products to RapiDoc
// 'cloud-v2': {
// specFile: path.join(API_DOCS_ROOT, 'influxdb/cloud/v2/ref.yml'),
// pagesDir: path.join(DOCS_ROOT, 'content/influxdb/cloud/api'),

View File

@ -131,7 +131,7 @@ function buildOperationsTocHtml(operations: OperationMeta[]): string {
let html = '<ul class="api-toc-list api-toc-list--operations">';
operations.forEach((op) => {
// Generate anchor ID from operationId (Scalar uses operationId for anchors)
// Generate anchor ID from operationId (RapiDoc uses operationId for anchors)
const anchorId = op.operationId;
const methodClass = getMethodClass(op.method);