From f9ae4ee2e4905a32c2c26e2f2b4253893fc161a2 Mon Sep 17 00:00:00 2001 From: Melinda Fekete Date: Mon, 4 Mar 2024 11:49:25 +0100 Subject: [PATCH] Improve docs for orderhint (#1938) --- websites/documentation/src/content/writing/release-notes.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/websites/documentation/src/content/writing/release-notes.mdx b/websites/documentation/src/content/writing/release-notes.mdx index 1b72c06e8d..f71219e5e0 100644 --- a/websites/documentation/src/content/writing/release-notes.mdx +++ b/websites/documentation/src/content/writing/release-notes.mdx @@ -61,7 +61,7 @@ If there is no more, remove the marker above, too. ## Available frontmatters: - `date` (date, required): A `YYYY-MM-DD` date format (not a text, it's parsed as an ISO date) -- `orderHint` (number, optional): A number that indicates the order of release notes with the same release date in the RSS feed. Use numbers in ascending order for all the release notes you want to order. +- `orderHint` (number, optional): Sorts release notes that share a release date within the same microsite. Uses an ascending order with 1 being the most recent release note. - `title` (string, required): The title for the website - `description` (string, required): Max 256 characters plain text containing the change and its advantage ("tweet-able" and for RSS). 256 = 280 twitter minus 23 for a link. Do not imply the title, this text is used stand-alone in Merchant Center and other feed recipients. It must convey the value proposition and key change topic.