Commit Graph

10 Commits

Author SHA1 Message Date
Evan Rusackas
1008a5a364 docs: consistent overview URLs, README revamp, homepage card polish
- Rename user-docs/intro to user-docs/ for consistent section landing
  pages (matching admin-docs/ and developer-docs/)
- Add redirect from /user-docs/intro for existing bookmarks
- Revamp README with Documentation header and three section links,
  condense quick-links row
- Remove emojis from homepage cards and developer-docs overview
- Widen subtitle container to prevent line wrap on homepage
- Fix Contributor Guide link to developer-docs/

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-02-25 17:43:06 -08:00
Evan Rusackas
43a7138b73 docs: move API reference to developer docs, add active nav state, remove package-lock.json
- 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>
2026-02-25 16:16:05 -08:00
Evan Rusackas
0fb7fc2721 docs: bifurcate documentation into user, admin, and developer sections
Major restructuring of documentation to separate concerns:

**New Structure:**
- `/docs/` - User-facing docs (intro, quickstart, databases, using-superset, faq)
- `/admin-docs/` - Administrator docs (installation, configuration, security)
- `/developer-docs/` - Developer docs (contributing, extensions, guidelines, testing)

**Changes:**
- Move installation, configuration, and security docs to admin_docs/
- Move contributing, extensions, guidelines, and testing to developer_docs/
- Rename developer_portal to developer_docs (with underscore to hyphen in URL)
- Add sidebarAdminDocs.js for admin documentation navigation
- Update versions-config.json with new doc sections
- Update docusaurus.config.ts with new plugins and redirects
- Update internal links in versioned docs (6.0.0) to use new paths
- Keep user-facing content (databases, using-superset, faq) in main docs

This separation makes it clearer which documentation is relevant for:
- End users exploring and visualizing data
- Administrators deploying and configuring Superset
- Developers contributing to or extending Superset

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-02-24 11:41:27 -08:00
Evan Rusackas
ad0186093f docs: add interactive API reference using docusaurus-openapi-docs (#37434)
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-28 11:16:25 -08:00
Evan Rusackas
b460ca94c6 feat(docs): auto-generate database documentation from lib.py (#36805)
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-21 10:54:01 -08:00
Evan Rusackas
90651dfe3e fix(dev/ci): pre-commit fixes galore (#32352) 2025-02-24 11:26:45 -07:00
Maxime Beauchemin
538d1bb245 docs: merge database config under Configuration section (#28281) 2024-04-30 18:39:32 -07:00
Maxime Beauchemin
a08c24c4aa docs: reorganize the CONTRIBUTING section (#28220)
Co-authored-by: Sam Firke <sfirke@users.noreply.github.com>
2024-04-26 17:49:21 -07:00
Braum
e8a678b75a docs: Refactor Documentation Structure (#28161)
Co-authored-by: Evan Rusackas <evan@preset.io>
Co-authored-by: Sam Firke <sfirke@users.noreply.github.com>
2024-04-24 15:17:50 -06:00
Hugh A. Miles II
9c3205b573 feat: 🚀 Docs V2 CI Script (#18560)
* switch to v2

* promote docv2

* remove on triggers
2022-02-02 13:02:51 -08:00