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

docs: re-organize guides - #7875

Merged
lalithsuresh merged 1 commit into
mainfrom
docs-use-cases
Nov 6, 2026
Merged

lalithsuresh merged 1 commit into
mainfrom
docs-use-cases

Conversation

@lalithsuresh

Copy link
Copy Markdown
Contributor

Linked Issue

None.

Describe Manual Test Plan

Ran the link checker to make sure nothing changed.

Checklist

  • Unit tests added/updated
  • Integration tests added/updated
  • Documentation updated
  • Changelog updated

Breaking Changes?

Mark if you think the answer is yes for any of these components:

Describe Incompatible Changes

Signed-off-by: Lalith Suresh <lalith@feldera.com>
Comment thread docs.feldera.com/docs/sidebars.js Resolved
Comment thread docs.feldera.com/docusaurus.config.ts Resolved
@mythical-fred-oss

Copy link
Copy Markdown
Contributor

What I ran: yarn install --frozen-lockfile and then docusaurus build in docs.feldera.com/. The build fails because the sidebar validation can't find doc ids use_cases/agents, use_cases/real-time-pipelines and use_cases/fraud-detection. The PR's test plan says the link checker passed, so these files probably exist locally but weren't committed.

Label Severity Issue
bug critical Three hub pages and src/components/UseCases are missing from the PR (see inline comments). The site can't build.
bug medium /img/favicon.svg isn't in the repo (see inline comment).
missing medium The PR deletes tutorials/writing-sql and tutorials/debugging-sql but adds no redirects. Their public URLs will 404. Add plugin-client-redirects entries, for example to /tutorials/basics/part1.
pitfall medium Moving tutorials/time-series, tutorials/testing and tutorials/monitoring changes their sidebar section but not their URL. Each now sits under Pipelines or Operations with a /tutorials/... URL. That's fine for now, but consider moving the files and adding redirects.
missing low The commit message is a bare subject. Add a body that says why the guides were reorganized and that the navbar and favicon also changed.

Gates: this is a docs-only change, so no test gate applies. The build is broken, though, so please fix the missing files before merging.

@lalithsuresh
lalithsuresh added this pull request to the merge queue Nov 6, 2026
Merged via the queue into main with commit 5e8d65a Nov 6, 2026
1 check passed
@lalithsuresh
lalithsuresh deleted the docs-use-cases branch November 6, 2026 22:03
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