docs: give the changelog its own section and fix its broken rendering - #18
Merged
Conversation
The changelog block rendered as one run-on paragraph on the live site: "Last Update Date: 29-Jul-2026 Last Updates: - Documented the three Ticket endpoints..." all on a single line. Cause: no blank line between `Last Updates:` and the list beneath it, so Redcarpet never started a list and folded every line into the same paragraph. This is inherited, not new. `master` had the same shape, so porting it faithfully in the previous commit reproduced the bug. Two changes: **Its own section.** It was buried inside Introduction, which is about what the API is, not what moved last week. `# Changelog` now sits at the end of the file, right before the Errors include, so the tail of the doc is reference material: endpoints, then changelog, then errors. A new reader still gets Introduction and Authentication first; a returning one clicks straight to it from the sidebar. Introduction keeps a one-line pointer. **Dates as bold text, not headings.** Slate builds the sidebar from h1 and h2, so a heading per date would add a nav entry every release and turn the sidebar into a date list. Bold keeps the nav at one entry regardless of how long the changelog grows. Also grouped the entries by date instead of repeating the date on every bullet, which is what made the original hard to scan, and dropped the redundant "Last Update Date" line since the topmost group already carries it. One judgment call worth naming: `master`'s block credited the portal-link update to Nov-2025, because that is when it was merged there. It never reached `main`, so the published site kept the old links until this branch. The entry sits under 29-Jul-2026, which is when it becomes true for anyone actually reading the site. Verified: every list has a blank line before it, and the three internal anchors still resolve. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The single 29-Jul-2026 group bundled work that landed on three different days, and dated all of it to the earliest. Checked against the merge timestamps rather than memory: #14 2026-07-29 Answers V5, manifest #15 2026-07-29 V5 fixes #16 2026-07-30 V5 fixes #17 2026-08-04 Ticket endpoints, portal links So Answers V5 finished landing on the 30th, not the 29th, and the Ticket endpoints and portal links are from today. Now two groups instead of one, each carrying only what shipped under it. Also added the changelog-section move itself to the 04-Aug group, since it is a visible change to the page and the changelog should record it. The dates matter here beyond tidiness: this file is the only place a customer can see when the endpoint they are reading about became available, and it is served publicly. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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
1 participant
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 changelog block rendered as one run-on paragraph on the live site: "Last Update Date: 29-Jul-2026 Last Updates: - Documented the three Ticket endpoints..." all on a single line.
Cause: no blank line between
Last Updates:and the list beneath it, so Redcarpet never started a list and folded every line into the same paragraph. This is inherited, not new.masterhad the same shape, so porting it faithfully in the previous commit reproduced the bug.Two changes:
Its own section. It was buried inside Introduction, which is about what the API is, not what moved last week.
# Changelognow sits at the end of the file, right before the Errors include, so the tail of the doc is reference material: endpoints, then changelog, then errors. A new reader still gets Introduction and Authentication first; a returning one clicks straight to it from the sidebar. Introduction keeps a one-line pointer.Dates as bold text, not headings. Slate builds the sidebar from h1 and h2, so a heading per date would add a nav entry every release and turn the sidebar into a date list. Bold keeps the nav at one entry regardless of how long the changelog grows.
Also grouped the entries by date instead of repeating the date on every bullet, which is what made the original hard to scan, and dropped the redundant "Last Update Date" line since the topmost group already carries it.
One judgment call worth naming:
master's block credited the portal-link update to Nov-2025, because that is when it was merged there. It never reachedmain, so the published site kept the old links until this branch. The entry sits under 29-Jul-2026, which is when it becomes true for anyone actually reading the site.Verified: every list has a blank line before it, and the three internal anchors still resolve.