docs: Add develop-docs with Perfetto profiling documentation#5750
Draft
markushi wants to merge 3 commits into
Draft
docs: Add develop-docs with Perfetto profiling documentation#5750markushi wants to merge 3 commits into
markushi wants to merge 3 commits into
Conversation
Introduce a develop-docs folder for internal developer documentation, with a README defining the docs conventions (flat structure, prefixes, naming, images, Mermaid) and a first feature doc covering the Android Perfetto profiling pipeline from the SDK through Relay to the monolith. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
📲 Install BuildsAndroid
|
runningcode
approved these changes
Jul 16, 2026
runningcode
left a comment
runningcode
left a comment
Contributor
There was a problem hiding this comment.
Looks good to me! I only reviewed the README.md in detail.
|
|
||
| ### File naming | ||
|
|
||
| - File names are **lowercase**. |
Contributor
There was a problem hiding this comment.
this one is README.md though?
|
|
||
| ### Directory structure | ||
|
|
||
| - Use a **flat directory structure** for all markdown files, they live live directly in `develop-docs/`. |
Contributor
There was a problem hiding this comment.
im wondering if a flat structure makes sense given that the repo has so many different modules and areas of concern like java/android/sprint/etc?
but i agree that it is best to start flat and then re-organize later if necessary.
| ## Pipeline overview | ||
|
|
||
| A profile chunk is captured on the device, embedded into a Sentry envelope, expanded and | ||
| routed by Relay, and finally symbolicated and stored by the monolith so it can be served |
Contributor
There was a problem hiding this comment.
link to what Relay is? (im not familiar with it)
| that don't belong in the public [Sentry docs](https://docs.sentry.io) or in inline | ||
| code comments. | ||
|
|
||
| If you are documenting **how** or **why** something works for the people who maintain |
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
2 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.
Summary
Introduces a
develop-docs/folder for internal developer documentation.README.md— defines the documentation conventions: flat directory structure with filename prefixes (general-,feature-,integration-,platform-,process-), lowercase dash-separated names, same-named folders for embedded assets, present-tense/active-voice writing, and Mermaid for diagrams.feature-perfetto-profiling.md— first feature doc, covering the Android Perfetto continuous-profiling pipeline end to end: capturing profile chunks viaandroid.os.ProfilingManager, themeta_lengthenvelope framing, Relay's Perfetto → Sample v2 conversion and object-store routing, and the monolith's storage, serving, and download endpoints.#skip-changelog
🤖 Generated with Claude Code