Skip to content

docs: add a brief system overview section #733

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: add a brief system overview section #733

wants to merge 1 commit into from

Conversation

gilligan
Copy link
Contributor

@gilligan gilligan commented Apr 30, 2025 •
edited
Loading

Description

This adds a "system overview" section to docs/intro.md. The diagram has been drawn with https://draw.io/ and can be modified using it as well.

Checklist

  • Commit sequence broadly makes sense and commits have useful messages.
  • The size limit of 400 LOC isn't needlessly exceeded
  • The PR refers to a JIRA ticket (if one exists)
  • New tests are added if needed and existing tests are updated.
  • New code is documented and existing documentation is updated.
  • Relevant logging and metrics added
  • Any changes are noted in the changelog.md for affected crate
  • Self-reviewed the diff

AmbientTea
AmbientTea reviewed Apr 30, 2025
View reviewed changes
@gilligan gilligan marked this pull request as draft April 30, 2025 11:50
@gilligan
docs: add a brief system overview diagram
fded17c 
This adds a "system overview" section to docs/intro.md. The
diagram has been drawn with https://draw.io/ and can be modified
using it as well.
@gilligan gilligan force-pushed the docs-add-system-overview branch from a423408 to fded17c Compare April 30, 2025 14:28
@gilligan gilligan marked this pull request as ready for review April 30, 2025 14:29
@gilligan gilligan requested a review from AmbientTea April 30, 2025 14:29
@gilligan gilligan changed the title docs: add a brief system overview diagram docs: add a brief system overview section Apr 30, 2025
@gilligan gilligan requested a review from nstanford5 April 30, 2025 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nstanford5 nstanford5 nstanford5 approved these changes

@AmbientTea AmbientTea Awaiting requested review from AmbientTea

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@gilligan @AmbientTea @nstanford5