Skip to content

docs: add timestamp metadata #3118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
BrendanBondurant wants to merge 2 commits into
base: main
Choose a base branch
from
+26 −0
Open

docs: add timestamp metadata #3118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7948d8f
add timestamp option
BrendanBondurant Jul 27, 2026
1bb0333
add frontmatter info into claude
BrendanBondurant Jul 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs-website/CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,29 @@ docs-website/
4. Include code examples where appropriate
5. Link between related documentation pages

### Frontmatter

Keep frontmatter sparse. Every content page should include:

```yaml
---
title: "..."
description: "..."
icon: ...
---
Comment on lines +92 to +99

@coderabbitai coderabbitai Bot Jul 27, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 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.

Suggested change
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.

@comatory comatory Jul 29, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@BrendanBondurant I think that's a fair comment

```

Snippets under `snippets/` do not need page frontmatter.

Do not use `dateModified`. Last-modified dates come from Mintlify's git-backed timestamps (`metadata.timestamp` in `docs.json`). Authors do not bump a date field. Set `timestamp: false` on a page only when a last-modified line would be misleading (redirect stubs, empty shells).

Opt-in fields (omit by default):

- `tag` — sidebar badge. Allowed values only: `New`, `Beta`, `Deprecated`. Apply only when true. Do not tag overview hubs or entire sections by default. Use `tag` only; do not also set Mintlify's `deprecated: true`.
- `sidebarTitle` — short nav label. Use `Overview` on section index/hub pages whose `title` is the full section name. Use a shortened label when the page title is too long for the sidebar. Keep the full `title` for the H1 and SEO. Do not add `sidebarTitle` on leaf pages with short titles.
- `noindex: true` — exclude from search engines, sitemaps, site search, and AI context. Page stays in navigation. Use for redirect stubs and pages that should not be indexed.
- `searchable: false` — exclude from in-product search and AI context only. Page remains externally indexable and in the sitemap. Rare. Prefer `noindex: true` for redirect stubs; do not set both.

## Common Tasks

### Adding a New Page
Expand Down
3 changes: 3 additions & 0 deletions docs-website/docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@
"appearance": {
"default": "dark"
},
"metadata": {
"timestamp": true
},
"styling": {
"codeblocks": "system",
"eyebrows": "breadcrumbs"
Expand Down
Loading