Skip to content

docs: Add develop-docs with Perfetto profiling documentation#5750

Draft
markushi wants to merge 2 commits into
mainfrom
feat/develop-docs
Draft

docs: Add develop-docs with Perfetto profiling documentation#5750
markushi wants to merge 2 commits into
mainfrom
feat/develop-docs

Conversation

@markushi

@markushi markushi commented Jul 9, 2026

Copy link
Copy Markdown
Member

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 via android.os.ProfilingManager, the meta_length envelope 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

markushi and others added 2 commits July 9, 2026 11:20
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>
@sentry

sentry Bot commented Jul 9, 2026

Copy link
Copy Markdown

📲 Install Builds

Android

🔗 App Name App ID Version Configuration
SDK Size io.sentry.tests.size 8.48.0 (1) release

⚙️ sentry-android Build Distribution Settings

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.

1 participant