Skip to content
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

Document our crate organization in ARCHITECTURE.md #4458

Merged
merged 6 commits into from Dec 10, 2023
Merged

Document our crate organization in ARCHITECTURE.md #4458

merged 6 commits into from Dec 10, 2023

Conversation

abey79
Copy link
Contributor

@abey79 abey79 commented Dec 7, 2023 •
edited by github-actions bot

What

Add a list of crates and an org diagram in ARCHITECTURE.md. Also add a lint to minimise the chance of rot.

Source FigJam: https://www.figma.com/file/Umob8ztK1HmYKLUMSq8aPb/Crates-org

Checklist

  • I have read and agree to Contributor Guide and the Code of Conduct
  • I've included a screenshot or gif (if applicable)
  • I have tested the web demo (if applicable):
    • Full build: app.rerun.io
    • Partial build: app.rerun.io - Useful for quick testing when changes do not affect examples in any way
  • The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG

@abey79 abey79 added 📖 documentation Improvements or additions to documentation include in changelog labels Dec 7, 2023
emilk
emilk requested changes Dec 7, 2023
View reviewed changes
Copy link
Member

@emilk emilk left a comment

Choose a reason for hiding this comment

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

I suggest moving the crate list and image to the bottom of ARCHITECTURE.md - it takes a lot of space now. Here it is rendered: https://github.com/rerun-io/rerun/blob/antoine/crate-diagram/ARCHITECTURE.md

scripts/lint.py Outdated Show resolved Hide resolved
scripts/lint.py Outdated Show resolved Hide resolved
scripts/lint.py Outdated Show resolved Hide resolved
abey79 and others added 4 commits December 7, 2023 16:39
@abey79 @emilk
Update scripts/lint.py
fed2605 
Co-authored-by: Emil Ernerfeldt <emil.ernerfeldt@gmail.com>
@abey79
Reorder sections
38fb72d
@abey79
Several improvement to lint:
52fb906 
- fix bug where crate mention check could lead to false positive
- support sub-folders in crates/
- check for non-existing crate mention (against "re_..." pattern)
@abey79
Add "interner" to cspell
61649d5
@emilk emilk merged commit c824555 into main Dec 10, 2023
40 checks passed
@emilk emilk deleted the antoine/crate-diagram branch December 10, 2023 20:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@emilk emilk emilk approved these changes

Assignees
No one assigned
Labels
📖 documentation Improvements or additions to documentation include in changelog
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@abey79 @emilk