Skip to content

[Chore] Add more descriptions to various frontmatter fields in our style guide and schema #24489

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

Merged
merged 2 commits into from
Aug 18, 2025
+18 −15
Merged

[Chore] Add more descriptions to various frontmatter fields in our style guide and schema #24489

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
4bf6888
[Chore] Add more descriptions to various frontmatter fields in our st…
kodster28 Aug 18, 2025
9f6e704
prettier
kodster28 Aug 18, 2025
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
10 changes: 0 additions & 10 deletions src/components/ProductReleaseNotes.astro
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,11 +94,6 @@ if (!releaseNotes) {
<AnchorHeading depth={2} title={page.data.title} />
</a>
<p class="text-xs">{entry.date}</p>
{page.data.release_notes_product_area_name && (
<h3 class="mt-4!">
<a href={entry.productLink}>{entry.product}</a>
</h3>
)}
{<Fragment set:html={description} />}
</div>
);
Expand All @@ -108,11 +103,6 @@ if (!releaseNotes) {
<>
<AnchorHeading depth={2} title={date} />
<div data-product={entry.product.toLowerCase()}>
{page.data.release_notes_product_area_name && (
<h3 class="mt-4!">
<a href={entry.productLink}>{entry.product}</a>
</h3>
)}
{entry.title && <strong>{entry.title}</strong>}
{<Fragment set:html={description} />}
</div>
Expand Down
23 changes: 18 additions & 5 deletions src/schemas/base.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,16 +81,24 @@ export const baseSchema = ({ image }: SchemaContext) =>
"This is used to automatically add the [LastReviewed component](/style-guide/components/last-reviewed/).",
),
spotlight: spotlightAuthorDetails,
release_notes_file_name: z.string().array().optional(),
release_notes_product_area_name: z.string().optional(),
release_notes_file_name: z
.string()
.array()
.optional()
.describe(
"Required for the [`ProductReleaseNotes`](/style-guide/components/usage/#productreleasenotes) component.",
),
products: z
.string()
.array()
.optional()
.describe(
"The names of related products, which show on some grids for Examples, [Tutorials](/style-guide/documentation-content-strategy/content-types/tutorial/), and [Reference Architectures](/style-guide/documentation-content-strategy/content-types/reference-architecture/)",
),
summary: z.string().optional(),
summary: z
.string()
.optional()
.describe("Renders a summary description directly below the page title."),
goal: z.string().array().optional(),
operation: z.string().array().optional(),
noindex: z
Expand All @@ -117,7 +125,9 @@ export const baseSchema = ({ image }: SchemaContext) =>
component: z.string(),
})
.optional()
.describe("Used by overrides for style guide component documentation"),
.describe(
"Used by overrides for style guide component documentation, which helps us display the [usage counts](/style-guide/components/usage/) for components directly on the component page itself.",
),
banner: z
.object({
content: z.string(),
Expand All @@ -129,7 +139,10 @@ export const baseSchema = ({ image }: SchemaContext) =>
.object({ id: z.string(), days: z.number().optional().default(7) })
.optional(),
})
.optional(),
.optional()
.describe(
"Displays a [Banner](https://developers.cloudflare.com/style-guide/frontmatter/banner/) on the current docs page.",
),
icon: SidebarIconSchema(),
feedback: z
.boolean()
Expand Down
Loading