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

Docs: new brand look and diagrams - #7841

Merged
lalithsuresh merged 26 commits into
mainfrom
docs-looks
Nov 5, 2026
Merged

lalithsuresh merged 26 commits into
mainfrom
docs-looks

Conversation

@tristencross

@tristencross tristencross commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor

Brings the docs into the new Feldera brand.

  • New typography, colours and code blocks (DM Sans, Geist Mono, brand palette).
  • All diagrams redrawn in the brand diagram style. Content and layout are unchanged.
  • Old logos and magenta buttons updated in a few screenshots.
  • Readable "On this page" menu on narrow screens, and a working navbar logo.

lalithsuresh and others added 26 commits October 30, 2026 20:51
Signed-off-by: Lalith Suresh <lalith@feldera.com>
* docs: tutorial part 3 supply chain diagram in the brand diagram style

* docs: part 3 diagram, darker Moss on the Feldera output so all arrows read the same weight
* docs: TPC-H schema diagram on batch part 1 in the brand diagram style

* docs: TPC-H schema, PARTSUPP's composite key joins and forks into LINEITEM as in the original; hyphenated rows and centred names
* docs: batch part 2 architecture diagram in the Warp Speed diagram style

* docs: batch part 2 diagram, table-to-view arrows no longer cross
* docs: batch part 3 architecture and Kafka offset diagrams in the Warp Speed diagram style

* docs: Kafka offset diagram, bird centred over LINEITEM and a shorter Feldera frame
title: "Feldera Documentation",
tagline: "Powerup your Data Lake with Incremental View Maintenance",
favicon: "img/favicon.ico",
favicon: "img/favicon.svg",

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.

bug (medium): there's no static/img/favicon.svg in this PR or in the tree; only favicon.ico exists, and this PR updates it. After a build, build/index.html has <link rel="icon" href="/?u=https%3A%2F%2Fgithub.com%2Fimg%2Ffavicon.svg"> and that file returns 404, so the site shows no favicon. Either add the SVG or keep pointing at the .ico:

Suggested change
favicon: "img/favicon.svg",
favicon: "img/favicon.ico",

// see custom.css --feldera-code-bg); worst case is now 6.10:1.
// Code block theme: the website's dark code window. The colours come from
// felderaDarkTheme (website2/src/utils/shiki-theme.mjs), mapped to Prism
// token types. The ground is Onyx (website2/docs/design-system.md, section 9).

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 public repo has no website2/... paths. The same goes for the references in src/css/custom.css (lines 3 and 361). Contributors can't follow them. Inline the values or rationale, or drop the pointers.

@mythical-fred-oss

Copy link
Copy Markdown
Contributor

This PR changes only the docs site: a new brand theme, fonts and code theme, plus redrawn diagrams. No product code changes, so the test gates don't apply.

What I ran

Check Result
yarn install --frozen-lockfile (docs.feldera.com) ✅
yarn build ✅ builds. The broken-anchor warnings also appear without this PR
pre-commit run --files <changed> ✅
Favicon in the built index.html ❌ points to /img/favicon.svg, which doesn't exist (see inline)

Findings

  • licensing (medium): the new @fontsource-variable/dm-sans and @fontsource-variable/geist-mono packages are OFL-1.1, not MIT or Apache-2.0. OFL is fine for web fonts on a docs site, but under our dependency rule it needs an explicit sign-off.
  • tech-debt (medium): the PR leaves orphaned assets: real_time_apps/spreadsheet-architecture-parts.svg, model_scoring/model-scoring-architecture.{svg,dot} and static/img/logo-color-{dark,light}.svg. Nothing references them any more. A commit in this PR removes the model-scoring .svg/.dot and the next one reverts it, so please decide whether to keep them and squash that pair.
  • commits (medium): several subject lines are cut off with …. There's also a remove/revert pair, and a commit that removes the source a diagram is generated from would need a reason in its message. Please squash and reword before merge.

@Karakatiza666

Copy link
Copy Markdown
Contributor

Looks off: too blue and thin. The color may be fine though. And too much space above

image

Vanilla scrollbar. let's come up with something nicer
image

Try styling the Python SDK pages
image

@Karakatiza666
Karakatiza666 self-requested a review November 4, 2026 21:44

@Karakatiza666 Karakatiza666 left a comment •

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.

The styling code became messier. Will have to be addressed in later PRs

@lalithsuresh
lalithsuresh added this pull request to the merge queue Nov 4, 2026
Merged via the queue into main with commit ea87c78 Nov 5, 2026
3 checks passed
@lalithsuresh
lalithsuresh deleted the docs-looks branch November 5, 2026 05:49
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.

3 participants