Repository navigation
Docs: Python SDK reference in the brand - #7866
Conversation
…o, Sink nav, Violet links, square corners, dark code
…rlines, no breadcrumbs
| # 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", |
There was a problem hiding this comment.
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?
| <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> |
There was a problem hiding this comment.
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).
|
What I ran:
No issues with dependencies, licensing, |
Updated the Python SDK in the new brand.