docs: rewrite README in concise style and split advanced topics into docs/#32
Merged
thanhhaudev merged 1 commit intomasterfrom Apr 26, 2026
Merged
docs: rewrite README in concise style and split advanced topics into docs/#32thanhhaudev merged 1 commit intomasterfrom
thanhhaudev merged 1 commit intomasterfrom
Conversation
…docs/ Cuts the main README from 513 to 87 lines by removing marketing prose, the FAQ, and 6 of 7 metric example blocks. Moves full reference content to docs/metrics.md, docs/configuration.md, docs/caching.md, and docs/scheduling.md so the landing page stays focused on quick start.
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.
Cuts the main README from 513 to 87 lines by removing marketing prose, the FAQ, and 6 of 7 metric example blocks. Moves full reference content to docs/metrics.md, docs/configuration.md, docs/caching.md, and docs/scheduling.md so the landing page stays focused on quick start.