[EPS-1397] Add engineering onboarding guide with diagrams#7
Open
marcelo-xavier-hf wants to merge 1 commit into
Open
[EPS-1397] Add engineering onboarding guide with diagrams#7marcelo-xavier-hf wants to merge 1 commit into
marcelo-xavier-hf wants to merge 1 commit into
Conversation
Add a docs/onboarding.md guided tour for engineers joining the team that owns grpc-protoc-plugins. Includes Mermaid diagrams (high-level architecture, dependency view, the release-flow sequence, and the distribution path) plus the required sections — Overview & Purpose, Tech Stack, Architecture, Key Modules, Data Flow, Local Dev Setup, Testing, Deployment — each cross-referenced to the workflow file and README.
Author
|
Repo not owned by GenAI enablement team. |
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
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
Adds a diagram-rich onboarding guide for engineers joining the team that owns this repo. The guide lives at
docs/onboarding.mdand is grounded in concrete file paths so a new mid/senior IC can ramp up without paging through the codebase.The doc covers:
grpc/grpc, no source of its own.linux@amd64+macos@amd64matrix..github/workflows/release.yml, theREADME.md, and theLICENSE.Documentation-only — no code changes.
Test plan
docs/onboarding.mdis the only file in the diff.🤖 Generated with Claude Code