Modernize README with improved structure and navigation#317
Merged
Modernize README with improved structure and navigation#317
Conversation
Reorganize the README from flat reference-manual style into a hierarchical, scannable layout with table of contents, collapsible sections, and mermaid diagrams. - Replace godoc.org badge with pkg.go.dev, add CI/version/license badges - Remove stale Gitter badge - Add Quick Start section and Key Features list - Replace seed.png reference with mermaid diagram - Add store architecture mermaid diagram - Group CLI commands by category in tables - Move options, env vars, config reference into tables - Organize examples by category with collapsible server/advanced sections - Add Platform Support table and Design Philosophy section - Add GCS to capabilities table, fix S3 verify (no, not yes) - Update golang.org links to go.dev/pkg.go.dev
Color-code nodes by role: - Seeds diagram: blue (external seeds), green (built-in seeds), orange (chunk store fallback), yellow (result file) - Store diagram: purple (client), green (cache), blue (router), yellow (stores), red (failover group)
- Add missing commands: config, chunk, manpage - Add missing global flags: --config, --digest, --verbose - Add missing store client TLS flags: --ca-cert, --client-cert, --client-key - Add missing retry flags: -e/--error-retry, -b/--error-retry-base-interval - Add missing server flags: -w, -u, --store-file, --mutual-tls, --client-ca, --authorization, --log - Add missing command-specific flags: --ignore, --input-format, --output-format, --print-stats, --skip-invalid-seeds, --regenerate-invalid-seeds, --format - Organize options into grouped sub-tables for clarity - Fix descriptions: cat outputs to files too, mtree accepts directories
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
<details>sectionsdoc/seed.pngreference with a mermaid diagram; add new store architecture mermaid diagramgolang.orglinks togo.dev/pkg.go.devNo content from the original README was removed — everything has been reorganized and in some cases reformatted (e.g. terminology as a table, options as a table).