From a3648a79a4c0e8e6de931cc0270cef46272545b9 Mon Sep 17 00:00:00 2001 From: Claude Date: Fri, 2 Jan 2026 01:48:06 +0000 Subject: [PATCH] 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/agents/ts-component-dev.md | 2 +- .claude/skills/hugo-template-dev/SKILL.md | 2 +- api-docs/scripts/dist/generate-openapi-articles.js | 4 ++-- api-docs/scripts/generate-openapi-articles.ts | 4 ++-- assets/js/components/api-toc.ts | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.claude/agents/ts-component-dev.md b/.claude/agents/ts-component-dev.md index 2f202d96e..107042460 100644 --- a/.claude/agents/ts-component-dev.md +++ b/.claude/agents/ts-component-dev.md @@ -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 diff --git a/.claude/skills/hugo-template-dev/SKILL.md b/.claude/skills/hugo-template-dev/SKILL.md index 7139074f0..3cfd1a488 100644 --- a/.claude/skills/hugo-template-dev/SKILL.md +++ b/.claude/skills/hugo-template-dev/SKILL.md @@ -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/ diff --git a/api-docs/scripts/dist/generate-openapi-articles.js b/api-docs/scripts/dist/generate-openapi-articles.js index 01f86067a..61e6448f7 100644 --- a/api-docs/scripts/dist/generate-openapi-articles.js +++ b/api-docs/scripts/dist/generate-openapi-articles.js @@ -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'), diff --git a/api-docs/scripts/generate-openapi-articles.ts b/api-docs/scripts/generate-openapi-articles.ts index 3b4570c98..4a1c745c9 100644 --- a/api-docs/scripts/generate-openapi-articles.ts +++ b/api-docs/scripts/generate-openapi-articles.ts @@ -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'), diff --git a/assets/js/components/api-toc.ts b/assets/js/components/api-toc.ts index b76571949..73db1c687 100644 --- a/assets/js/components/api-toc.ts +++ b/assets/js/components/api-toc.ts @@ -131,7 +131,7 @@ function buildOperationsTocHtml(operations: OperationMeta[]): string { let html = '