docs: document the blog changelog layout - #6731
Draft
devin-ai-integration[bot] wants to merge 2 commits into
Draft
docs: document the blog changelog layout#6731devin-ai-integration[bot] wants to merge 2 commits into
devin-ai-integration[bot] wants to merge 2 commits into
Conversation
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
|
|
||
| A changelog is a navigation entry that renders a dated timeline of entries. Point the `changelog` key at a folder and every Markdown file in it becomes an entry, grouped by date, with search and tag filtering built in. A changelog can go wherever a section can — as its own tab, or as an entry in your sidebar. | ||
| A changelog is a navigation entry that renders dated entries. Point the `changelog` key at a folder and every Markdown file in it becomes an entry, grouped by date, with search and tag filtering built in. A changelog can go wherever a section can — as its own tab, or as an entry in your sidebar. |
Contributor
There was a problem hiding this comment.
📝 [vale] <Microsoft.OxfordComma> reported by reviewdog 🐶
Use the Oxford comma in ', with search and tag filtering built in.'.
Contributor
|
🌿 Preview your docs: https://fern-preview-devin-1787587342-blog-layout-docs.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
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
1 participant
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
Documents the blog presentation for changelogs on the existing changelog page (no new page):
layout: blogin a changelog'soverview.mdx, theblog-layout: grid | listknob, the post metadata the layout reads (author registry,slug, excerpt fallbacks,thumbnail/image,draft/hidden), and theblog:navigation key as an alias forchangelog:.Also adds a one-clause pointer from the
layout.changelog-layoutParamField in site settings (the site-wide setting still accepts onlytimelineandclassic—blogis per-changelog only), plus a Docs changelog entry.Draft until the feature ships. The behavior documented here comes from three unmerged PRs:
bloglayout andblog-layoutvariantsblog:navigation aliasblog/postschangelog slugs to serve feedsEverything else on the page is unchanged: a blog is a changelog with different chrome, so dated entry filenames, reserved overview filenames, search, tag filtering, entry pages, and the rss/atom/json feeds all behave identically.
Link to Devin session: https://app.devin.ai/sessions/da27e5183b724ee0953e0cd3f4cbcd06