docs: add timestamp metadata - #3118
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
WalkthroughThe documentation site now enables timestamp metadata, and its authoring guide documents frontmatter requirements, timestamp handling, and optional fields. ChangesDocumentation timestamp metadata
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs-website/CLAUDE.md`:
- Around line 92-99: Update the frontmatter template in the authoring guidance
so content pages require only title and description; remove icon from the
required fields or clearly label it optional, consistent with the existing
optional-icon guidance.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 1ce099e6-9a38-4e3d-99d9-9cf7e787f7fe
📒 Files selected for processing (2)
docs-website/CLAUDE.mddocs-website/docs.json
| Keep frontmatter sparse. Every content page should include: | ||
|
|
||
| ```yaml | ||
| --- | ||
| title: "..." | ||
| description: "..." | ||
| icon: ... | ||
| --- |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Do not require icon on every content page.
The existing authoring guidance treats icon as optional, but this template says every page must include it. Remove icon from the required template or explicitly mark it as optional.
Proposed fix
Keep frontmatter sparse. Every content page should include:
---
title: "..."
description: "..."
-icon: ...
---📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Keep frontmatter sparse. Every content page should include: | |
| ```yaml | |
| --- | |
| title: "..." | |
| description: "..." | |
| icon: ... | |
| --- | |
| Keep frontmatter sparse. Every content page should include: | |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs-website/CLAUDE.md` around lines 92 - 99, Update the frontmatter template
in the authoring guidance so content pages require only title and description;
remove icon from the required fields or clearly label it optional, consistent
with the existing optional-icon guidance.
There was a problem hiding this comment.
@BrendanBondurant I think that's a fair comment
| Keep frontmatter sparse. Every content page should include: | ||
|
|
||
| ```yaml | ||
| --- | ||
| title: "..." | ||
| description: "..." | ||
| icon: ... | ||
| --- |
There was a problem hiding this comment.
@BrendanBondurant I think that's a fair comment
2 participants
Summary by CodeRabbit
Checklist
Open Source AI Manifesto
This project follows the principles of the Open Source AI Manifesto. Please ensure your contribution aligns with its principles.