← 输入框|github.com|刷新
Skip to content

Docs: Python SDK reference in the brand - #7866

Merged
lalithsuresh merged 2 commits into
mainfrom
docs-python-sdk-style
Nov 7, 2026
Merged

lalithsuresh merged 2 commits into
mainfrom
docs-python-sdk-style

Conversation

@tristencross

@tristencross tristencross commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor
Screenshot 2026-11-05 at 2 40 14 PM

Updated the Python SDK in the new brand.

Comment thread python/docs/conf.py
# The Feldera brand on top of the theme, to match docs.feldera.com: DM Sans and Geist Mono, then the
# brand stylesheet in _static/.
html_css_files = [
"https://fonts.googleapis.com/css2?family=DM+Sans:opsz,wght@9..40,400;9..40,500;9..40,600&family=Geist+Mono:wght@400;500;600&display=swap",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

pitfall (medium): The main docs self-host these fonts (@fontsource-variable/dm-sans and geist-mono in docusaurus.config.ts). This line instead loads them from Google Fonts on every SDK page, which sends each visitor's IP to Google (a known GDPR problem) and adds a third-party request that can block rendering. The main site also uses the font family name "DM Sans Variable", not 'DM Sans', so the two sites resolve different faces. Could you self-host the woff2 files under _static/ instead?

Comment on lines +7 to +21
<a class="fd-top-logo" href="https://www.feldera.com" aria-label="Feldera">
<img src="/img/logo-black.svg" alt="Feldera" width="70" height="31" />
</a>
<nav class="fd-top-links" aria-label="Docs">
<a href="/get-started">Get Started</a>
<a href="/sql">SQL Reference</a>
<a href="/connectors">Connectors</a>
<a href="{{ pathto(root_doc) }}" class="is-current" aria-current="page">Python SDK</a>
</nav>
<nav class="fd-top-right" aria-label="Community">
<a href="https://join.slack.com/t/felderacommunity/shared_invite/zt-3vf3n5dj5-HJuC1DFFY2wE1_AZUyNxqw">Slack</a>
<a href="https://discord.com/invite/s6t5n9UzHE">Discord</a>
<a href="https://github.com/feldera/feldera">GitHub</a>
</nav>
</header>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

tech-debt (medium): This copies the Docusaurus navbar from docusaurus.config.ts, including the Slack invite token, and nothing keeps the two in sync. When the Slack invite is rotated or a nav item changes, this copy will keep pointing at the old target. It also adds a "Python SDK" item that the main navbar doesn't have, so the bar changes as soon as you leave this section. The root-relative /img/..., /get-started and similar links only work when the HTML is served from the docs.feldera.com root: in a local make html they all 404, including the logo image. Consider a short comment saying where the source of truth lives, or generating these links from conf.py (html_context).

@mythical-fred-oss

Copy link
Copy Markdown
Contributor

What I ran: sphinx-apidoc and sphinx-build -M html, the same steps as build-docs.yml, on a copy of python/docs. The build passed (1 warning, which already existed). In the rendered HTML, the top bar, the Python SDK · <version> side label and the search box are all present. The is-current link resolves to index.html or # as expected. This PR changes only CSS and a template, so no automated tests apply. I didn't open the pages in a browser.

Gate / area Severity Note
Manual testing description (hard rule 1) missing, medium The PR body is empty, and a styling-only change can't be checked by tests. Please add before/after screenshots for desktop and for mobile (under 768px, with the side menu open). The fixed 64px bar and the forced 260px nav both override the theme's responsive layout.
Commit messages missing, medium Both subject lines are cut off with … and continue into the body, and neither commit has a body explaining why. Please rebase into one commit with a short imperative subject.
Fonts medium Fonts come from Google Fonts instead of being self-hosted like the main docs (see inline comment).
Nav duplication medium The template hard-codes a copy of the Docusaurus navbar and Slack invite, and its root-relative links break outside docs.feldera.com (see inline comment).

No issues with dependencies, licensing, unsafe, or CI workflows.

@lalithsuresh
lalithsuresh added this pull request to the merge queue Nov 7, 2026
Merged via the queue into main with commit 527742a Nov 7, 2026
3 checks passed
@lalithsuresh
lalithsuresh deleted the docs-python-sdk-style branch November 7, 2026 17:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants