ci: add deep reverse-engineering documentation workflow with Stage 8 agent-native context#1
Merged
nayyarsan merged 3 commits intoMar 20, 2026
Conversation
…r script and initial docs Co-authored-by: nayyarsan <29976473+nayyarsan@users.noreply.github.com> Agent-Logs-Url: https://github.com/nayyarsan/MyBudgetApp/sessions/404ce691-d4c5-46c1-97f1-ce43baafb1ca
Copilot
AI
changed the title
[WIP] Create new workflow for deep reverse engineering
ci: add deep reverse-engineering documentation workflow
Mar 20, 2026
…ctions.md, symbol_index.md, brownfield_context.md) Co-authored-by: nayyarsan <29976473+nayyarsan@users.noreply.github.com> Agent-Logs-Url: https://github.com/nayyarsan/MyBudgetApp/sessions/8b8b67ac-4c1d-42e0-983a-6b32059ed19f
Copilot
AI
changed the title
ci: add deep reverse-engineering documentation workflow
ci: add deep reverse-engineering documentation workflow with Stage 8 agent-native context
Mar 20, 2026
nayyarsan
approved these changes
Mar 20, 2026
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.
Adds an automated workflow that performs structural reverse engineering of the Flutter/Dart codebase on every functional
lib/change, generates comprehensive documentation through 8 stages, and opens a PR with the results.Workflow (
.github/workflows/reverse_engineering_docs.yml)pushtomainfor non-generatedlib/**/*.dartchanges; short-circuits if no functional Dart file actually changedworkflow_dispatchfor manual runsdocs/reverse-engineering-autobranch PR viapeter-evans/create-pull-request@v7Generator script (
.github/scripts/generate_docs.py)Single self-contained Python script (stdlib only). Stages write output incrementally:
_manifest.json_inventory.json— 52 files, role-tagged (screen,provider,dao, etc.)intermediate/signatures/{cluster}.json— classes, methods, providers, importsintermediate/dependency_graph.json— provider chains, cross-feature imports, sync boundaryintermediate/data_model.json— Drift schemas, DAO queries, Firestore collection mapintermediate/logic_summaries/{cluster}.jsonintermediate/business_intent.jsonfiles.md,features/*.md(×10),data_model.md,flows/*.md(×6),README.mdStage 8 — Agent-native context files
Produces files consumed directly by coding agents rather than humans:
AGENTS.md(repo root) — auto-read by Copilot coding agent and Claude Code before every task; includes feature map, data model quick-ref, naming conventions, and codebase rules.github/copilot-instructions.md— injected into every Copilot Chat session; kept ≤500 tokens (data flow, key files, critical rules).github/docs/symbol_index.md— grep-friendly flat tables: 26 providers, 41 DAO methods, 8 tables, 15 screens, 6 calculators/services — each with file location and key metadata.github/docs/brownfield_context.md— copy-into-context pack for new feature work: existing features, step-by-step add-feature pattern, all table/provider names in use, extension gaps, test coverage gapsInitial baseline
All generated outputs for the current 52-file codebase are committed alongside the workflow and script.
📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.