Skip to content

Conversation

@embano1
Copy link
Member

@embano1 embano1 commented Jan 6, 2026

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.

@embano1 embano1 linked an issue Jan 6, 2026 that may be closed by this pull request
Copy link
Contributor

@leandrodamascena leandrodamascena left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@leandrodamascena
Copy link
Contributor

leandrodamascena commented Jan 6, 2026

Hey @embano1 pls push a new commit with semantic stuff.. like "docs: update readm file and fix docs"

@leandrodamascena leandrodamascena changed the title Update README and fix docs links docs: update README and fix docs links Jan 6, 2026
@embano1
Copy link
Member Author

embano1 commented Jan 6, 2026

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 embano1 force-pushed the docs-readme branch 3 times, most recently from b8c5ead to 9de8703 Compare January 6, 2026 11:57
Add onboarding-focused README content and testing guidance.\nMove architecture diagrams into docs and remove broken advanced links.

Signed-off-by: Michael Gasch <[email protected]>
@embano1 embano1 linked an issue Jan 6, 2026 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs]: Refresh README to focus on users [Docs]: Broken links to docs/advanced

2 participants