Skip to content

feat(docs): split cookbooks per product and add how-to shelves - #940

Draft
saif-at-scalekit wants to merge 5 commits into
mainfrom
docs/group-general-articles
Draft

feat(docs): split cookbooks per product and add how-to shelves#940
saif-at-scalekit wants to merge 5 commits into
mainfrom
docs/group-general-articles

Conversation

@saif-at-scalekit

@saif-at-scalekitsaif-at-scalekit commented Aug 11, 2026

Copy link
Copy Markdown
Collaborator

Summary

Splits the single /cookbooks/ blog into four per-product starlight-blog instances, and uses two of them as a knowledge base for dashboard and workspace tasks.

starlight-blog 0.28.0 added support for multiple blog instances, so cookbooks and how-to guides share one mechanism instead of needing a hand-built listing page.

InstanceHoldsArticles
/agentkit/cookbooks/AgentKit recipes12
/saaskit/cookbooks/Auth for SaaS recipes10
/agentkit/how-to/AgentKit dashboard tasks1
/saaskit/how-to/Workspace and account tasks3

Why

AgentKit readers could not find cookbooks. The Cookbooks nav item existed only in the Auth for SaaS row, yet 12 of the 22 cookbooks are AgentKit content. AgentKit now has a matching Developer Resources dropdown.

Dashboard how-tos had no home. Workspace tasks like billing, environments, and team members sat in the Developer Kit guides as orphans — no sidebar entry, zero or one inbound link each.

Commits

  1. chore(deps) — upgrade starlight-blog 0.26.1 → 0.28.0, convert config to array form, fix the MarkdownContent override.
  2. refactor(cookbooks) — split into two instances, move 22 files, add 22 redirects, retarget existing rules, add a /cookbooks/ hub page.
  3. feat(how-to) — add both how-to instances, move 3 workspace pages, wire the Developer Resources dropdowns.

Two things worth a look

Blog chrome was silently disabled and is now on.src/components/overrides/MarkdownContent.astro rendered Starlight's default directly, shadowing starlight-blog's own override. Cookbooks have therefore never shown the author byline or reading time that metrics configures. Nesting the plugin's override restores both — so all 22 cookbooks now display author and reading time where they previously showed neither.

Which dashboard pages moved. Only pages that are self-contained dashboard tasks moved. Pages that are steps inside an implementation journey stayed:

PageInbound linksDecision
environments, manage-team-members0, 0Moved
billing1Moved
custom-email-templates2Stays — Customize phase
auth-logs5Stays — Go Live phase
redirects12Stays — journey step
allowed-callback-url, org-redirect-urls, intitate-login-endpoint3, 2, 1Stay — journey steps

The three moved pages keep their existing noindex robots meta. Flag it if a knowledge base should be indexable.

Verification

pnpm build passes, which runs starlight-links-validator and prettier --check. Blog listing and tag pages are injected routes rather than content entries, so the validator cannot resolve them and they are excluded; individual posts stay validated.

Preview

@coderabbitai

coderabbitaiBot commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 7d214e9b-457d-4790-8ab0-fbe2cba7d659

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Comment @coderabbitai help to get the list of available commands.

@netlify

netlifyBot commented Aug 11, 2026

Copy link
Copy Markdown

Deploy Preview for scalekit-starlight ready!

NameLink
🔨 Latest commitd80f63d
🔍 Latest deploy loghttps://app.netlify.com/projects/scalekit-starlight/deploys/6a7c038f396e23000834529a
😎 Deploy Previewhttps://deploy-preview-940--scalekit-starlight.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 76 (🟢 up 6 from production)
Accessibility: 100 (no change from production)
Best Practices: 92 (no change from production)
SEO: 92 (no change from production)
PWA: -
View the detailed breakdown and full score reports
🤖 Make changesRun an agent on this branch

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

@saif-at-scalekitsaif-at-scalekit changed the title docs: group general articles under a shared sectionfeat(docs): split cookbooks per product and add how-to shelvesAug 11, 2026
0.28.0 adds support for multiple blog instances, which the knowledge base
work needs. The upgrade is a plain minor bump: 0.27.0 requires Starlight
>=0.41.0 and Astro v7, both already satisfied.
Converts the plugin config to the array form with the single existing
cookbooks entry, and sets navigation: 'none' — the default 'header-end'
adds a header link per instance, which does not scale past one blog.
Also fixes the MarkdownContent override, which rendered Starlight's
default directly and so shadowed starlight-blog's own override. Cookbook
posts have therefore never shown the author byline or the reading time
the metrics option configures. Nesting the plugin's override restores
both while keeping image zoom and video content intact.
Cookbooks now live in two starlight-blog instances, /agentkit/cookbooks/
and /saaskit/cookbooks/, so each product's recipes are browsable from
that product's navigation. AgentKit readers previously had no nav path to
cookbooks at all, despite 12 of the 22 being AgentKit content.
Moves 12 articles to AgentKit and 10 to Auth for SaaS, adds a redirect
for every old URL, and retargets the existing rules that pointed into
/cookbooks/. /cookbooks/ stays as a hub page linking to both shelves.
The astro-d2 output path follows the MDX location, so the diagrams for
the LiteLLM cookbook move with it. Blog listing and tag pages are
injected routes rather than content entries, so the link validator
cannot resolve them and they are excluded; individual posts stay
validated.
Adds /agentkit/how-to/ and /saaskit/how-to/ as blog instances, giving
dashboard and workspace tasks a home separate from the product journeys.
Both shelves reach readers through the Developer Resources dropdown,
which AgentKit now has to match Auth for SaaS.
Moves the three workspace administration pages out of the Developer Kit
guides. They were orphans there: no sidebar entry, and zero or one
inbound link each. The remaining guides/dashboard pages stay put because
they are steps inside an implementation journey rather than standalone
tasks — redirects, callback URLs, and email templates are all reached
from the pages that need them.
Reading time is disabled on the how-to instances; it reads as blog
furniture on a short dashboard answer.
Switching product blanked the secondary nav for the whole page load.
applyProductChrome() hid every nav row whose product did not match the
new selection, but only shared self-hosted paths render both rows —
everywhere else renders a single row for the current product. On those
pages the one row present was hidden and nothing replaced it until the
destination page painted.
Swap rows only when more than one is present. A single row is about to
be replaced by navigation, so leaving it visible shows the current tabs
briefly instead of an empty bar. SecondaryNav.astro already guards its
equivalent on data-shared-path; this is the missing counterpart.
@saif-at-scalekit
saif-at-scalekitforce-pushed the docs/group-general-articles branch from 123cf9a to d80f63dCompareAugust 12, 2026 05:24
Sign up for freeto 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.

1 participant

@saif-at-scalekit