New high-level architecture documentation #3063
Draft
+99
−72
Conversation
This file contains 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
emilk
added
📖 documentation
emilk
force-pushed
the
emilk/new-architecture-docs
branch
from
f4baf6f
to
8dfeb5e
Compare
3 tasks
|
Illustration drafts: https://excalidraw.com/#token=L613-Db80muC3D7Di7p9C
|
…grated the content elsewhere. Extensibility still TODO.
emilk
added a commit
that referenced
this pull request
Aug 22, 2023
### What I saw this in #3063 <img width="482" alt="Screenshot 2023-08-22 at 13 40 24" src="https://github.com/rerun-io/rerun/assets/1148717/dd741d41-641d-41a2-89d1-77311b719879"> and spotted several problems: A) there was nothing in that PR changing the .rrd files B) the comparison format uses way too many decimals C) the comparison uses "KB" which isn't a unit The first problem should be fixed by turning off time-based batch flushing (first commit). ### Checklist * [x] I have read and agree to [Contributor Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and the [Code of Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md) * [x] I've included a screenshot or gif (if applicable) * [x] I have tested [demo.rerun.io](https://demo.rerun.io/pr/3064) (if applicable) - [PR Build Summary](https://build.rerun.io/pr/3064) - [Docs preview](https://rerun.io/preview/pr%3Aemilk%2Fdeterministic-web-demo/docs) - [Examples preview](https://rerun.io/preview/pr%3Aemilk%2Fdeterministic-web-demo/examples) - [Recent benchmark results](https://ref.rerun.io/dev/bench/) - [Wasm size tracking](https://ref.rerun.io/dev/sizes/) --------- Co-authored-by: Jan Procházka <[email protected]>
|
First sense after reading this is that it has way too little detail. It conveys a very small part of the interesting technical approaches and architecture which kind of defeats the point. I think the same goes for the diagrams. |
|
is this still worth saving or already too outdated? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Go away. This is not ready for review.
TODO
ARCHITECTURE.mdtoCONTRIBUTING.mdor newarchitecture.mdARCHITECTURE.mdwith a link to the new oneChecklist