docs: redesign READMEs with centered hero and website screenshot - #76
Merged
Conversation
Rework both READMEs into a product-showcase layout aligned with the conventions of well-regarded OSS readmes (khoj, ant-design, context7): - Centered header: official Yuque logo (GitHub org avatar), title, two-line tagline, three uniform flat-square badges, emoji nav row that also hosts the language-switch links (previously a stranded top line) - Local screenshot of the skills-only website build as the hero visual (.github/assets/website.png) - New Skills (8) section surfacing every skill with a one-line description extracted from its SKILL.md - Repository tree folded into <details>, validate-skills.mjs added to the Development section - zh (primary) and en kept structurally identical Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
13 tasks
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.
What does this PR do?
Visual redesign of the READMEs in a product-showcase layout, following the conventions of well-regarded OSS readmes (khoj, ant-design, context7). Post-#75 follow-up: the docs now also look like the storefront the repo is positioned as.
README.mdis the English version, Chinese lives inREADME.zh-CN.md(matching the yuque-mcp-server convention);README.en.mdis removed and language-switch links updated.flat-squarebadges (website / deploy / yuque-mcp), and an emoji nav row that now hosts the language-switch links (previously a stranded line above the title)..github/assets/website.png.SKILL.md— the repo's core asset was previously invisible in the README.<details>,validate-skills.mjsadded to Development, table cells kept as short phrases.Verified with
gh api markdownrendering + screen-by-screen browser screenshots for both languages;node scripts/validate-skills.mjspasses; all badge URLs return 200.Related Issues
Follow-up to #75; hero screenshot includes #77.
Type of Change
Affected Area
READMEs only (no area option matches; template predates #75).
Checklist
🤖 Generated with Claude Code