QT/superset2
1
0
Fork 0
mirror of https://github.com/apache/superset.git synced 2026-04-24 18:44:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: move API reference to developer docs, add active nav state, remove package-lock.json

Browse Source 
- Move API reference from user-docs to developer-docs section:
  - Change OpenAPI plugin docsPluginId from 'classic' to 'developer_docs'
  - Move api.mdx and update outputDir to developer_docs/api
  - Update all three API generation scripts to use new paths
  - Update sidebars, navbar items, and redirect targets
  - Add redirect from /user-docs/api to /developer-docs/api
  - Update .gitignore for new generated API path

- Add activeBaseRegex to navbar dropdowns so the active section
  highlights when browsing sub-pages (Users, Admins, Developers,
  Community)

- Fix dropdown active link styling to use primary color instead
  of being invisible (transparent)

- Remove accidental empty package-lock.json from repo root
  (added in SIP-32, 2019)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Evan Rusackas
2026-02-25 16:16:05 -08:00
parent d2740d226c
commit 43a7138b73
12 changed files with 50 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/scripts/convert-api-sidebar.mjs
View File

@@ -28,8 +28,8 @@ import path from 'path';
import { fileURLToPath } from 'url';
const __dirname = path.dirname(fileURLToPath(import.meta.url));
const sidebarTsPath = path.join(__dirname, '..', 'docs', 'api', 'sidebar.ts');
const sidebarJsPath = path.join(__dirname, '..', 'docs', 'api', 'sidebar.js');
const sidebarTsPath = path.join(__dirname, '..', 'developer_docs', 'api', 'sidebar.ts');
const sidebarJsPath = path.join(__dirname, '..', 'developer_docs', 'api', 'sidebar.js');
if (!fs.existsSync(sidebarTsPath)) {
console.log('No sidebar.ts found, skipping conversion');