docs: update README and fix docs links#247
Merged
Conversation
Contributor
|
Hey @embano1 pls push a new commit with semantic stuff.. like "docs: update readm file and fix docs" |
leandrodamascena
changed the title
Member
Author
|
I'd like @yaythomas to go through the changes and also comment whether removing the broken (missing) sections is ok or whether to build them out as part of this PR (would need help though). |
embano1
force-pushed
the
docs-readme
branch
3 times, most recently
from
b8c5ead to
9de8703
Compare
Add onboarding-focused README content and testing guidance.\nMove architecture diagrams into docs and remove broken advanced links. Signed-off-by: Michael Gasch <15986659+embano1@users.noreply.github.com>
yaythomas
approved these changes
Jan 13, 2026
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
3 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.
Issue #, if available: #235
Description of changes:
Add onboarding-focused README content and testing guidance.\nMove architecture diagrams into docs and remove broken advanced links.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.