docs: improve README structure and add conceptual overview - #362
Merged
Conversation
Tony133
force-pushed
the
docs/improve-readme
branch
from
August 25, 2026 20:21
58ef865 to
37fc7cb
Compare
- Add 'How Avvio works' section explaining the plugin tree, load order and boot lifecycle - Add ASCII diagrams for plugin tree, boot lifecycle and error flow - Clarify differences between use(), after() and ready() - Add error codes table with descriptions - Reorganize API reference for easier navigation
Tony133
force-pushed
the
docs/improve-readme
branch
from
August 25, 2026 20:22
37fc7cb to
2274a7b
Compare
Tony133
marked this pull request as ready for review
August 25, 2026 21:30
Eomm
approved these changes
Sep 1, 2026
Closed
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.
Proposal:
Changes:
"How Avvio works"section explaining the plugin tree, load order, and boot lifecycle before the API referenceuse(),after(), andready()AVV_ERR_*) with descriptionsCloses issue: #24