docs: give release-note sections real structure - #41
Merged
Conversation
added 4 commits
August 14, 2026 16:35
The 1.5.0 entry rendered as one wall of text: a bold label with no blank
line after it is joined into the paragraph below by Markdown, so every
section came out as <p><strong>label</strong> body...</p>.
- release-notes.mdx: blank line between every label and its body
- global.css: style label paragraphs like headings (spacing, weight) so a
section reads as heading + body. Bold labels stay instead of real
headings on purpose - one page holds every release, and real headings
would put a hundred entries in the table of contents.
- Update: id={label}, so docs.fluso.ai/release-notes#2026-08-14 works again
the way it did on Mintlify. Release announcements link that way.
- publish-release-notes.yml: the blank line is now a stated rule, so the
next generated entry cannot repeat this.
Dense five-sentence sections read as a wall even once the heading is separated. Every section is now short bullets carrying one point each, which is the rhythm the 1.4.0 and 1.3.5 entries have. Nothing is dropped. List items get a little vertical room, and the workflow prompt now states bullets as the required section shape.
Each entry now answers to two addresses: #2026-08-14 and #v1.5.0. The date badge and the version line are the links, so a reader can copy the address of one release instead of sending the whole page. The version anchor sits above the entry so the sticky header does not cover it after the jump.
Bullets that carried two or three points still read as paragraphs with a dot in front. Split them so every bullet is one statement, which is the rhythm of the 1.4.0 and 1.3.5 entries. 55 bullets now, average 82 characters against 134 in 1.4.0 - nothing dropped, only split.
charitra-prem
approved these changes
Aug 14, 2026
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
2 participants
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.
The v1.5.0 entry renders as one wall of text - the bold section labels are glued into the paragraph beneath them.
Cause: in Markdown a line of
**text**followed directly by prose is one paragraph. Older entries hid this because their labels were followed by bullet lists, which do break the paragraph.What this changes:
content/docs/release-notes.mdx- blank line between every label and its body (9 places, all in the 1.5.0 entry).app/global.css- label paragraphs inside an entry get heading spacing and weight, so a section reads as heading + body. Improves the older entries too. Bold labels are kept rather than real headings on purpose: this page holds every release, and real headings would put ~100 items in the table of contents.components/mintlify.tsx- each entry getsid={label}, sodocs.fluso.ai/release-notes#2026-08-14resolves again. Mintlify used to generate these; the port dropped them, and release announcements link that way..github/workflows/publish-release-notes.yml- the blank line is now an explicit rule in the prompt, so the next generated entry cannot repeat this.Verified with a local
next buildand the rendered HTML: label and body are separate<p>elements, the CSS rules compile, andid="2026-08-14"is present.🤖 Generated with Claude Code