Add frontmatter and sidebar ordering to docs/ for the new docs site - #558
Open
HappyDevs1 wants to merge 1 commit into
Open
Add frontmatter and sidebar ordering to docs/ for the new docs site#558HappyDevs1 wants to merge 1 commit into
HappyDevs1 wants to merge 1 commit into
Conversation
The new Automators docs site (docs.automators.com, see
automators-com/docs) renders each product's docs/ folder with Fumadocs,
which requires title (and reads description) from YAML frontmatter, and
uses a meta.json for sidebar ordering. Neither existed here yet, so the
site's build failed outright on every one of these 17 files
("title: Invalid input: expected string, received undefined").
- Added `title`/`description` frontmatter to every docs/*.md file, and
removed each file's leading `# Heading` line since the site renders
the title separately (DocsTitle) — left in place it would have shown
twice.
- Added docs/meta.json ordering pages by what a first-time reader needs:
getting-started, authoring, recording, self-help, agent-testing,
capture, multi-surface first, then the rest.
Not touched: docs/loop/ (corpus.yaml, ledger.yaml,
milestones/m2-falsifiability.md) looks like internal planning content
rather than documentation, and now that files need frontmatter to
publish, it's excluded from the site by the same rule rather than a
special case — flagging here in case docs/loop/ should move out of
docs/ entirely so it doesn't sit inside what's now a public-facing
folder.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
title/descriptionYAML frontmatter to every file indocs/, required by the new Automators docs site (Fumadocs-based, seeautomators-com/docs) — without it,next buildthere fails outright on all 17 files.# Headingline since the site renders the title separately; left in, it would show twice on every page.docs/meta.jsonfor sidebar ordering (getting-started → authoring → recording → self-help → agent-testing → capture → multi-surface, then the rest).Not touched — needs a decision
docs/loop/(corpus.yaml,ledger.yaml,milestones/m2-falsifiability.md) looks like internal planning content, not documentation. I didn't add frontmatter tomilestones/m2-falsifiability.md, so it's excluded from the new site by the same title-frontmatter rule rather than a special case — but flagging that it may be worth movingdocs/loop/out ofdocs/entirely, since that folder is now effectively public-facing.Test plan
next buildsucceeds and all 17 pages render (previously failed on every file)docs/loop/milestones/m2-falsifiability.mdcorrectly does not publish (404s)meta.json, no duplicate headingdocs/loop/disposition