Skip to content

fix(docs): update API documentation links for consistency and clarity#39077

Closed
shantanukhond wants to merge 1 commit intoapache:masterfrom
shantanukhond:docs/fix-broken-link-getting-started
Closed

fix(docs): update API documentation links for consistency and clarity#39077
shantanukhond wants to merge 1 commit intoapache:masterfrom
shantanukhond:docs/fix-broken-link-getting-started

Conversation

@shantanukhond
Copy link
Copy Markdown

@shantanukhond shantanukhond commented Apr 3, 2026

SUMMARY

  • Doc generators: docs/scripts/fix-openapi-spec.py and docs/scripts/extract_custom_errors.py now run on Python 3.9 (e.g. macOS system python3) by adding from __future__ import annotations (avoids runtime errors on X | Y type hints). extract_custom_errors.py no longer uses zip(..., strict=False) (3.10+ only).
  • Database docs: docs/scripts/generate-database-docs.mjs invokes python3 instead of python when running the optional Flask-backed path, fixing spawnSync python ENOENT on machines that only expose python3.
  • Homepage: docs/src/pages/index.tsx Get Started now points to /user-docs/ instead of /docs/intro, matching the current user-docs base path used elsewhere in the site.

BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF

Skip (or note: Get Started previously opened /docs/intro, now opens /user-docs/).

Before
https://github.com/user-attachments/assets/0620d161-9585-4b65-a623-3f1716cf74bf

After
https://github.com/user-attachments/assets/38d43f63-cef1-42ce-8de9-3f850bcb10a9

TESTING INSTRUCTIONS

  1. From repo root: cd docs && yarn install && yarn start (or yarn start:quick after a successful full run). Confirm no failure in generate:smart / api-docs on Python 3.9 + macOS-style python3 only.
  2. Open the docs home page; click Get Started and confirm the URL is /user-docs/ and the page loads.
  3. Optional: cd docs && node scripts/generate-if-changed.mjs and confirm it exits 0.

ADDITIONAL INFORMATION

  • Has associated issue:
  • Required feature flags:
  • Changes UI (homepage CTA target URL only)
  • Includes DB Migration (follow approval process in SIP-59)
    • Migration is atomic, supports rollback & is backwards-compatible
    • Confirm DB migration upgrade and downgrade tested
    • Runtime estimates and downtime expectations provided
  • Introduces new feature or API
  • Removes existing feature or API

@bito-code-review
Copy link
Copy Markdown
Contributor

bito-code-review Bot commented Apr 3, 2026

Code Review Agent Run #44d05c

Actionable Suggestions - 0
Additional Suggestions - 1
  • docs/developer_docs/api.mdx - 1
    • API Doc Formatting Inconsistency · Line 180-180
      The OAuth2 endpoint has inconsistent formatting: the description uses 'OAuth2' while the slug uses 'o-auth-2', which doesn't match the pattern seen in other changes like 'SqlLab' becoming 'Sql Lab' and 'sql-lab'. This creates inconsistency in the API docs.
      Code suggestion
       @@ -180,1 +180,1 @@
      -| `GET` | [Receive personal access tokens from OAuth2](/developer-docs/api/receive-personal-access-tokens-from-o-auth-2) | `/api/v1/database/oauth2/` |
      +| `GET` | [Receive personal access tokens from OAuth 2](/developer-docs/api/receive-personal-access-tokens-from-oauth-2) | `/api/v1/database/oauth2/` |
Review Details
  • Files reviewed - 5 · Commit Range: bf2357b..bf2357b
    • docs/developer_docs/api.mdx
    • docs/scripts/extract_custom_errors.py
    • docs/scripts/fix-openapi-spec.py
    • docs/scripts/generate-database-docs.mjs
    • docs/src/pages/index.tsx
  • Files skipped - 0
  • Tools
    • Whispers (Secret Scanner) - ✔︎ Successful
    • Detect-secrets (Secret Scanner) - ✔︎ Successful
    • MyPy (Static Code Analysis) - ✔︎ Successful
    • Astral Ruff (Static Code Analysis) - ✔︎ Successful

Bito Usage Guide

Commands

Type the following command in the pull request comment and save the comment.

  • /review - Manually triggers a full AI review.

  • /pause - Pauses automatic reviews on this pull request.

  • /resume - Resumes automatic reviews.

  • /resolve - Marks all Bito-posted review comments as resolved.

  • /abort - Cancels all in-progress reviews.

Refer to the documentation for additional commands.

Configuration

This repository uses Superset You can customize the agent settings here or contact your Bito workspace admin at evan@preset.io.

Documentation & Help

AI Code Review powered by Bito Logo

@github-actions github-actions Bot added the doc Namespace | Anything related to documentation label Apr 3, 2026
@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 3, 2026

Deploy Preview for superset-docs-preview ready!

Name Link
🔨 Latest commit bf2357b
🔍 Latest deploy log https://app.netlify.com/projects/superset-docs-preview/deploys/69cf35dbfcb04400083a6c63
😎 Deploy Preview https://deploy-preview-39077--superset-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@rusackas rusackas requested review from Copilot, rusackas and sfirke April 3, 2026 17:32
@rusackas rusackas added the review:checkpoint Last PR reviewed during the daily review standup label Apr 3, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR aligns the docs site’s navigation and API reference links with the current Docusaurus route base paths, while making the docs generator scripts compatible with Python 3.9 and “python3-only” environments.

Changes:

  • Update docs homepage “Get Started” CTA to point to /user-docs/.
  • Make docs generator scripts runnable on Python 3.9 by adding from __future__ import annotations and removing zip(..., strict=False).
  • Standardize docs database generator to invoke python3 (fixes spawnSync python ENOENT) and refresh API reference links for consistent slugs.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file
File Description
docs/src/pages/index.tsx Updates homepage CTA link target to /user-docs/ to match the current docs base path.
docs/scripts/generate-database-docs.mjs Uses python3 for the Flask-backed generation path to avoid missing python executable.
docs/scripts/fix-openapi-spec.py Adds future annotations import to prevent runtime evaluation issues with X | Y annotations on Python 3.9.
docs/scripts/extract_custom_errors.py Adds future annotations import and removes Python 3.10+ zip(strict=...) usage for Python 3.9 compatibility.
docs/developer_docs/api.mdx Updates a set of API reference links to consistent/expected slugs for generated endpoint pages.

@sfirke
Copy link
Copy Markdown
Member

sfirke commented Apr 5, 2026

Do the changes from "oath2" to "o-auth-2" and similar for "dashboard-s" fix currently broken links or are they a result of the other changes? Trying to understand the main point of this PR. Can you state that in a way other than the AI summary? Thank you.

@sadpandajoe sadpandajoe removed the review:checkpoint Last PR reviewed during the daily review standup label Apr 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Namespace | Anything related to documentation size/M

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants