Give the docs folder a more polished layout - #18
Merged
Merged
Conversation
Add a docs index page with a card layout, give each reference doc an icon title, a navigation row, and a tagline, and turn key notes and warnings into GitHub callouts. Section headings are unchanged so existing anchor links keep working. release-notes.md is left as is because it becomes the GitHub release text. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01BUhabxL4SPejg19jgbSyYN
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.
Change
Brings the
docs/folder in line with the refreshed README (#16) and wiki (#17).docs/README.md: an index page. GitHub shows it when you opendocs/. It has a centered header, a link to the wiki, cards for each doc grouped into "Using" and "Building and releasing", and a table for the other contents of the folder (release notes,wiki/,images/,history/).installation,user-guide,operations,setup-and-workspaces,development,releases):history/: the "historical notes" banner is now a warning callout.##) are unchanged, so existing anchor links in the README, CONTRIBUTING, and between docs keep working.release-notes.mdis unchanged, becausenpm run release:draftuses it as the GitHub release text.Page text is unchanged apart from being split into callouts. Prettier reflowed the tables in
releases.mdand one list inhistory/UI-POLISH.md.Validation
npx prettier --writeon the changed Markdown.npm run check: passes.npm test: 78/78 pass.🤖 Generated with Claude Code
https://claude.ai/code/session_01BUhabxL4SPejg19jgbSyYN
Generated by Claude Code