docs: add repository README with system architecture diagram - #2
Merged
Merged
Conversation
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
This repo had no top-level README — landing on it from GitHub gave no orientation. This adds one that explains what StepFi-Docs is, links the live docs.page site, maps the content structure (
docs/+docs.json), and documents how to edit/preview pages and what CI validates. Includes a committed system-architecture diagram highlighting the Docs repo's role in the protocol.Changes
README.md— overview, live docs link, content map, editing/preview guide, CI note, related-repos table.architecture.svg— the StepFi system diagram with the Docs box highlighted as "this repo".Notes
docs.jsonchanged.node .github/scripts/validate-docs.mjsstill passes (31/31 sidebar links resolve). The new root-level files are outsidedocs/and don't affect validation.