feat(docs): add blog: docs.yml config key [FSE-57] - #17468
Draft
adidavid014 wants to merge 1 commit into
Draft
Conversation
Adds a first-class `blog:` navigation key to docs.yml, mirroring `changelog:` end-to-end. A blog is a directory of dated markdown posts that the docs bundle renders as a card grid (vs. the changelog timeline). Part of epic FSE-53; design in fern-platform docs/adr/0023-formal-blog-support.md. - docs.yml schema: BlogConfiguration / BlogFolderRelativePath, added to the NavigationItem union and as a `blog:` tab (DocsYmlSchemas.ts + generated api/serialization schemas + the committed docs-yml.schema.json). - ParsedDocsConfiguration: TabbedNavigationChild.Blog + DocsNavigationItem.Blog. - Parser: tab + nav-item blog branches, isRawBlogConfig, DEFAULT_BLOG_TITLE; getAllPages + getReferencedApiSections blog cases. - New BlogNodeConverter (mirrors ChangelogNodeConverter; same year/month/entry tree, but title/filename-based entry slugs). Wired into DocsDefinitionResolver (toBlogNode / toTabBlogNode + the variant/nav/tab dispatchers). - docs-validator: validates blog-folder markdown pages. NOTE (draft): depends on @fern-api/fdr-sdk shipping the `blog`/`blogEntry` FernNavigation node types (fern-platform PR #13396). CI will be red until the SDK catalog pin is bumped to a version that includes BlogNode. Verified to compile locally against a linked local fdr-sdk build. Co-Authored-By: Claude <noreply@anthropic.com>
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
2 participants
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
Part of epic FSE-53 (Formal blog support). Adds a first-class
blog:navigation key todocs.yml, mirroringchangelog:end-to-end. A blog is a directory of dated markdown posts that the docs bundle renders as a card grid (vs. the changelog timeline). Design: fern-platformdocs/adr/0023-formal-blog-support.md.Authoring is identical to a changelog:
Changes (19 files, mirrors
changelog:)BlogConfiguration/BlogFolderRelativePath, added to theNavigationItemunion and as ablog:tab (DocsYmlSchemas.ts, the generatedschemas/sdk/{api,serialization}types, and the committeddocs-yml.schema.json).ParsedDocsConfiguration—TabbedNavigationChild.Blog+DocsNavigationItem.Blog.isRawBlogConfig,DEFAULT_BLOG_TITLE;getAllPages+getReferencedApiSectionsblog cases.BlogNodeConverter(new) — mirrorsChangelogNodeConverter(same year/month/entry tree) but with title/filename-based entry slugs. Wired intoDocsDefinitionResolver(toBlogNode/toTabBlogNode+ the variant/nav/tab dispatchers).This depends on
@fern-api/fdr-sdkshipping theblog/blogEntryFernNavigationnode types (fern-platform PR #13396). CI will be red until the CLI's@fern-api/fdr-sdkcatalog pin is bumped to a version that includesBlogNode. Verified to compile locally against a linked localfdr-sdkbuild.Merge order: land fern-platform #13396 → publish
fdr-sdk→ bump the catalog here → this goes green.How it was tested
All CLI packages (
configuration,configuration-loader,docs-resolver,docs-validator) compile clean against a linked localfdr-sdkwithBlogNode; biome-formatted. Full end-to-end render pending the SDK publish + a fix for the pre-existing local-bundle build breakage (FSE-63).Generated with Claude Code