docs: add API link and gap diagram to README - #108
Merged
Conversation
Adds the reference API to the quick-nav row and Related table, previously only referenced inline in the Pattern 1 code example, not as a discoverable link. Adds the gap diagram to the What is AVE section so the core problem is visible at a glance, not just described in prose. Moved images/ave-gap-diagram.svg to docs/images/ave-gap-diagram.svg (git mv, history preserved) and referenced it by relative path -- the assumed aveproject.org/images/ hosting path returned a 404 (GitHub Pages soft-404 HTML, not the SVG), so this uses the already-committed repo copy instead of guessing at a site URL that doesn't resolve.
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.
Adds api.aveproject.org as a discoverable link (quick-nav row and Related table) rather than only appearing inline in a code sample. Adds the gap diagram to the What is AVE section.
Diagram hosting: the assumed aveproject.org/images/ave-gap-diagram.svg path returned a 404 (GitHub Pages soft-404 HTML, confirmed by content, not just status code). The file already existed in this repo at images/ave-gap-diagram.svg (1200x740, valid SVG, confirmed before use) -- moved to docs/images/ave-gap-diagram.svg via git mv (history preserved) and referenced by relative path instead of guessing at an unresolvable site URL.