docs: condense README and add documentation links (follow-up to #51)#52
Merged
Conversation
Replace the 570-line README (which duplicated the docs section content) with a focused 170-line gateway that: - Keeps the intro, badges, GIF, How It Works, and Features sections - Adds prominent links to the live demo and documentation - Condenses Quick Start to a minimal working example with links - Replaces detailed reference sections (installation, shortcode params, source adapters, persistence, RSS, CSS theming, events, keyboard shortcuts, troubleshooting) with a Documentation table linking to each docs page - Keeps the Development section (project structure, test suites, source adapter guide) which is unique README content - Updates the demo GIF alt text to reflect new docs and language features The README now serves as a landing page that funnels users to the comprehensive in-theme documentation at exampleSite/content/docs/.
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.
Summary
Follow-up to #51. The README was 570 lines and duplicated the full documentation now available in the example site. This PR condenses it to a focused ~170-line gateway.
What changed
Removed (duplicate content now in docs):
Added:
Kept (unique README value):