contextcompass 2.15.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- contextcompass-2.15.0.dist-info/METADATA +673 -0
- contextcompass-2.15.0.dist-info/RECORD +452 -0
- contextcompass-2.15.0.dist-info/WHEEL +4 -0
- contextcompass-2.15.0.dist-info/entry_points.txt +2 -0
- contextcompass-2.15.0.dist-info/licenses/LICENSE +21 -0
- contextcompass_cli/__init__.py +74 -0
- contextcompass_cli/__main__.py +195 -0
- contextcompass_cli/_package/AGENTS.MD +310 -0
- contextcompass_cli/_package/CONTEXT_COMPACTION.md +110 -0
- contextcompass_cli/_package/MANIFEST.md +485 -0
- contextcompass_cli/_package/PROFILE_CLASS_CREATION_GUIDE.md +426 -0
- contextcompass_cli/_package/README.md +266 -0
- contextcompass_cli/_package/SKILLS.MD +144 -0
- contextcompass_cli/_package/agent_onboarding/default/continuity_fact_checker/AGENTS.MD +54 -0
- contextcompass_cli/_package/agent_onboarding/default/continuity_fact_checker/README.md +43 -0
- contextcompass_cli/_package/agent_onboarding/default/continuity_fact_checker/SKILLS.MD +44 -0
- contextcompass_cli/_package/agent_onboarding/default/continuity_fact_checker/WORKFLOWS.MD +15 -0
- contextcompass_cli/_package/agent_onboarding/default/continuity_fact_checker/behavioral_guidelines/continuity_fact_checker_workflow.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/continuity_fact_checker/examples/continuity_fact_checker_task_flow.md +24 -0
- contextcompass_cli/_package/agent_onboarding/default/continuity_fact_checker/policies/continuity_fact_checker_handoff_policy.md +20 -0
- contextcompass_cli/_package/agent_onboarding/default/continuity_fact_checker/policies/continuity_fact_checker_quality_policy.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/continuity_fact_checker/skills/continuity_fact_checker.md +37 -0
- contextcompass_cli/_package/agent_onboarding/default/continuity_fact_checker/skills/continuity_fact_checker_advanced_context.md +17 -0
- contextcompass_cli/_package/agent_onboarding/default/continuity_fact_checker/skills/continuity_fact_checker_deliverables.md +26 -0
- contextcompass_cli/_package/agent_onboarding/default/continuity_fact_checker/skills/continuity_fact_checker_execution.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/continuity_fact_checker/workflows/README.md +8 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/AGENTS.MD +85 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/README.md +62 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/SKILLS.MD +74 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/WORKFLOWS.MD +15 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/behavioral_guidelines/design_engineer_workflow.md +25 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/behavioral_guidelines/design_validation_and_handoff.md +25 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/examples/adr_example.md +40 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/examples/design_task_flow.md +33 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/policies/decision_record_policy.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/policies/design_quality_policy.md +30 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/policies/design_review_policy.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/policies/system_document_quality_rubric.md +236 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/adr_and_decision_hygiene.md +38 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/api_and_interface_design.md +36 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/architecture_contexts.md +40 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/architecture_patch_contracts.md +43 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/architecture_tradeoffs.md +33 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/code_description_patch_contracts.md +46 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/component_patch_contracts.md +41 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/data_modeling.md +34 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/decomposition_and_boundaries.md +42 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/design_engineer_execution.md +65 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/design_review_protocol.md +34 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/nonfunctional_requirements.md +34 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/patch_framework_design.md +79 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/requirements_to_architecture.md +39 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/src_architecture_instructions.md +347 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/src_components_instructions.md +405 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/system_design_method.md +45 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/tests_architecture_instructions.md +375 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/skills/tests_components_instructions.md +406 -0
- contextcompass_cli/_package/agent_onboarding/default/design_engineer/workflows/README.md +8 -0
- contextcompass_cli/_package/agent_onboarding/default/developmental_editor/AGENTS.MD +53 -0
- contextcompass_cli/_package/agent_onboarding/default/developmental_editor/README.md +42 -0
- contextcompass_cli/_package/agent_onboarding/default/developmental_editor/SKILLS.MD +44 -0
- contextcompass_cli/_package/agent_onboarding/default/developmental_editor/WORKFLOWS.MD +15 -0
- contextcompass_cli/_package/agent_onboarding/default/developmental_editor/behavioral_guidelines/developmental_editor_workflow.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/developmental_editor/examples/developmental_editor_task_flow.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/developmental_editor/policies/developmental_editor_handoff_policy.md +20 -0
- contextcompass_cli/_package/agent_onboarding/default/developmental_editor/policies/developmental_editor_quality_policy.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/developmental_editor/skills/developmental_editor.md +36 -0
- contextcompass_cli/_package/agent_onboarding/default/developmental_editor/skills/developmental_editor_advanced_context.md +17 -0
- contextcompass_cli/_package/agent_onboarding/default/developmental_editor/skills/developmental_editor_deliverables.md +25 -0
- contextcompass_cli/_package/agent_onboarding/default/developmental_editor/skills/developmental_editor_execution.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/developmental_editor/workflows/README.md +8 -0
- contextcompass_cli/_package/agent_onboarding/default/draft_writer/AGENTS.MD +54 -0
- contextcompass_cli/_package/agent_onboarding/default/draft_writer/README.md +43 -0
- contextcompass_cli/_package/agent_onboarding/default/draft_writer/SKILLS.MD +44 -0
- contextcompass_cli/_package/agent_onboarding/default/draft_writer/WORKFLOWS.MD +15 -0
- contextcompass_cli/_package/agent_onboarding/default/draft_writer/behavioral_guidelines/draft_writer_workflow.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/draft_writer/examples/draft_writer_task_flow.md +24 -0
- contextcompass_cli/_package/agent_onboarding/default/draft_writer/policies/draft_writer_handoff_policy.md +20 -0
- contextcompass_cli/_package/agent_onboarding/default/draft_writer/policies/draft_writer_quality_policy.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/draft_writer/skills/draft_writer.md +37 -0
- contextcompass_cli/_package/agent_onboarding/default/draft_writer/skills/draft_writer_advanced_context.md +17 -0
- contextcompass_cli/_package/agent_onboarding/default/draft_writer/skills/draft_writer_deliverables.md +26 -0
- contextcompass_cli/_package/agent_onboarding/default/draft_writer/skills/draft_writer_execution.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/draft_writer/workflows/README.md +8 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/AGENTS.MD +493 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/README.md +53 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/SKILLS.MD +263 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/WORKFLOWS.MD +15 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/behavioral_guidelines/engineer_workflow.md +24 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/behavioral_guidelines/task_execution_and_validation.md +34 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/examples/artifact_workflow.md +104 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/examples/eng_task_flow.md +30 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/policies/ctx_autonomy_policy.md +34 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/policies/ctx_autonomy_rubric.md +161 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/policies/engineer_quality_policy.md +33 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/skills/context_protocol.md +70 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/skills/documentation_standards.md +120 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/skills/engineer_execution.md +62 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/skills/package_maintenance.md +195 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/skills/patch_artifact_consumption.md +68 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/skills/patch_framework_gating.md +72 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/skills/src_graph_generation.md +341 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/skills/src_graph_usage.md +161 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/skills/staleness_protocol.md +49 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/skills/system_document_build.md +360 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/skills/system_orientation.md +83 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/skills/technical_expertise.md +48 -0
- contextcompass_cli/_package/agent_onboarding/default/engineer/workflows/README.md +9 -0
- contextcompass_cli/_package/agent_onboarding/default/general/AGENTS.MD +283 -0
- contextcompass_cli/_package/agent_onboarding/default/general/README.md +38 -0
- contextcompass_cli/_package/agent_onboarding/default/general/SKILLS.MD +92 -0
- contextcompass_cli/_package/agent_onboarding/default/general/WORKFLOWS.MD +23 -0
- contextcompass_cli/_package/agent_onboarding/default/general/behavioral_guidelines/README.md +12 -0
- contextcompass_cli/_package/agent_onboarding/default/general/behavioral_guidelines/agent_lifecycle_and_heartbeat.md +37 -0
- contextcompass_cli/_package/agent_onboarding/default/general/behavioral_guidelines/onboarding_summary.md +41 -0
- contextcompass_cli/_package/agent_onboarding/default/general/behavioral_guidelines/work_intake_and_execution.md +44 -0
- contextcompass_cli/_package/agent_onboarding/default/general/policies/policy_skills.md +174 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/active_documentation.md +86 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/active_pointerboard.md +81 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/agent_identity.md +38 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/agent_lifecycle.md +21 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/agent_stance.md +38 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/career_selection.md +83 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/compaction_requirements.md +147 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/configuration_standards.md +72 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/context_compaction.md +104 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/context_gold.md +31 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/context_management.md +79 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/context_window_budget.md +64 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/execution_contract.md +234 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/general.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/llm_full_usage.md +111 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/mailbox_protocol.md +85 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/memory_management.md +28 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/mrp_policy.md +40 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/package_upgrade.md +135 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/reactive_documentation.md +105 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/repo_topology.md +25 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/role_local_workflows.md +41 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/security_and_secrets.md +46 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/self_certification.md +49 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/ticket_closure_attention_sync.md +57 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/ticket_microcycle.md +44 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/ticketing.md +175 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/ticketing_skill_contract.md +52 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/unknowns_gate_reference.md +66 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/user_approved_certification.md +32 -0
- contextcompass_cli/_package/agent_onboarding/default/general/skills/workflow.md +289 -0
- contextcompass_cli/_package/agent_onboarding/default/general/workflows/README.md +9 -0
- contextcompass_cli/_package/agent_onboarding/default/general/workflows/cleanup_context_compass.md +205 -0
- contextcompass_cli/_package/agent_onboarding/default/general/workflows/role_creation.md +39 -0
- contextcompass_cli/_package/agent_onboarding/default/general/workflows/start_context_compass_work.md +102 -0
- contextcompass_cli/_package/agent_onboarding/default/general/workflows/sync_attention_board.md +91 -0
- contextcompass_cli/_package/agent_onboarding/default/general/workflows/turn_in_selected_tickets.md +95 -0
- contextcompass_cli/_package/agent_onboarding/default/general/workflows/workflow_creation.md +38 -0
- contextcompass_cli/_package/agent_onboarding/default/line_copy_editor/AGENTS.MD +53 -0
- contextcompass_cli/_package/agent_onboarding/default/line_copy_editor/README.md +42 -0
- contextcompass_cli/_package/agent_onboarding/default/line_copy_editor/SKILLS.MD +44 -0
- contextcompass_cli/_package/agent_onboarding/default/line_copy_editor/WORKFLOWS.MD +15 -0
- contextcompass_cli/_package/agent_onboarding/default/line_copy_editor/behavioral_guidelines/line_copy_editor_workflow.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/line_copy_editor/examples/line_copy_editor_task_flow.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/line_copy_editor/policies/line_copy_editor_handoff_policy.md +20 -0
- contextcompass_cli/_package/agent_onboarding/default/line_copy_editor/policies/line_copy_editor_quality_policy.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/line_copy_editor/skills/line_copy_editor.md +36 -0
- contextcompass_cli/_package/agent_onboarding/default/line_copy_editor/skills/line_copy_editor_advanced_context.md +17 -0
- contextcompass_cli/_package/agent_onboarding/default/line_copy_editor/skills/line_copy_editor_deliverables.md +25 -0
- contextcompass_cli/_package/agent_onboarding/default/line_copy_editor/skills/line_copy_editor_execution.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/line_copy_editor/workflows/README.md +8 -0
- contextcompass_cli/_package/agent_onboarding/default/new/AGENTS.MD +79 -0
- contextcompass_cli/_package/agent_onboarding/default/new/README.md +54 -0
- contextcompass_cli/_package/agent_onboarding/default/new/SKILLS.MD +35 -0
- contextcompass_cli/_package/agent_onboarding/default/new/WORKFLOWS.MD +15 -0
- contextcompass_cli/_package/agent_onboarding/default/new/behavioral_guidelines/user_onboarding_flow.md +52 -0
- contextcompass_cli/_package/agent_onboarding/default/new/policies/new_onboarding_policy.md +59 -0
- contextcompass_cli/_package/agent_onboarding/default/new/skills/configuration_map_guide.md +83 -0
- contextcompass_cli/_package/agent_onboarding/default/new/skills/first_time_profile_setup.md +60 -0
- contextcompass_cli/_package/agent_onboarding/default/new/skills/new.md +54 -0
- contextcompass_cli/_package/agent_onboarding/default/new/skills/onboarding_completion_and_next_step.md +54 -0
- contextcompass_cli/_package/agent_onboarding/default/new/skills/profile_model_explained.md +120 -0
- contextcompass_cli/_package/agent_onboarding/default/new/skills/system_overview_for_user.md +51 -0
- contextcompass_cli/_package/agent_onboarding/default/new/workflows/README.md +8 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/AGENTS.MD +63 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/README.md +41 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/SKILLS.MD +62 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/WORKFLOWS.MD +15 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/behavioral_guidelines/incident_workflow.md +17 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/behavioral_guidelines/platform_engineer_workflow.md +18 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/examples/platform_task_flow.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/policies/operational_safety_policy.md +20 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/policies/platform_quality_policy.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/policies/production_change_management_policy.md +18 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/skills/ci_cd_and_release.md +28 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/skills/deployment_and_environments.md +25 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/skills/incident_response_and_runbooks.md +35 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/skills/infrastructure_as_code.md +24 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/skills/observability_and_monitoring.md +28 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/skills/performance_capacity_cost.md +20 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/skills/platform_engineer_execution.md +41 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/skills/platform_security_basics.md +25 -0
- contextcompass_cli/_package/agent_onboarding/default/platform_engineer/workflows/README.md +8 -0
- contextcompass_cli/_package/agent_onboarding/default/proofreader/AGENTS.MD +53 -0
- contextcompass_cli/_package/agent_onboarding/default/proofreader/README.md +42 -0
- contextcompass_cli/_package/agent_onboarding/default/proofreader/SKILLS.MD +44 -0
- contextcompass_cli/_package/agent_onboarding/default/proofreader/WORKFLOWS.MD +15 -0
- contextcompass_cli/_package/agent_onboarding/default/proofreader/behavioral_guidelines/proofreader_workflow.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/proofreader/examples/proofreader_task_flow.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/proofreader/policies/proofreader_handoff_policy.md +20 -0
- contextcompass_cli/_package/agent_onboarding/default/proofreader/policies/proofreader_quality_policy.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/proofreader/skills/proofreader.md +36 -0
- contextcompass_cli/_package/agent_onboarding/default/proofreader/skills/proofreader_advanced_context.md +17 -0
- contextcompass_cli/_package/agent_onboarding/default/proofreader/skills/proofreader_deliverables.md +25 -0
- contextcompass_cli/_package/agent_onboarding/default/proofreader/skills/proofreader_execution.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/proofreader/workflows/README.md +8 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/AGENTS.MD +58 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/README.md +41 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/SKILLS.MD +61 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/WORKFLOWS.MD +15 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/behavioral_guidelines/qa_workflow.md +18 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/behavioral_guidelines/release_signoff_workflow.md +17 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/examples/qa_task_flow.md +24 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/policies/defect_severity_policy.md +24 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/policies/quality_gate_policy.md +18 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/policies/test_evidence_policy.md +18 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/skills/bug_triage_and_repro.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/skills/qa_engineer_execution.md +29 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/skills/quality_metrics.md +24 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/skills/regression_and_release_quality.md +28 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/skills/test_automation_practices.md +30 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/skills/test_case_design.md +27 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/skills/test_data_and_environments.md +20 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/skills/test_strategy_and_planning.md +31 -0
- contextcompass_cli/_package/agent_onboarding/default/qa_engineer/workflows/README.md +8 -0
- contextcompass_cli/_package/agent_onboarding/default/researcher/AGENTS.MD +55 -0
- contextcompass_cli/_package/agent_onboarding/default/researcher/README.md +44 -0
- contextcompass_cli/_package/agent_onboarding/default/researcher/SKILLS.MD +44 -0
- contextcompass_cli/_package/agent_onboarding/default/researcher/WORKFLOWS.MD +15 -0
- contextcompass_cli/_package/agent_onboarding/default/researcher/behavioral_guidelines/researcher_workflow.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/researcher/examples/researcher_task_flow.md +25 -0
- contextcompass_cli/_package/agent_onboarding/default/researcher/policies/researcher_handoff_policy.md +20 -0
- contextcompass_cli/_package/agent_onboarding/default/researcher/policies/researcher_quality_policy.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/researcher/skills/researcher.md +38 -0
- contextcompass_cli/_package/agent_onboarding/default/researcher/skills/researcher_advanced_context.md +17 -0
- contextcompass_cli/_package/agent_onboarding/default/researcher/skills/researcher_deliverables.md +27 -0
- contextcompass_cli/_package/agent_onboarding/default/researcher/skills/researcher_execution.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/researcher/workflows/README.md +8 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/AGENTS.MD +55 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/README.md +43 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/SKILLS.MD +62 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/WORKFLOWS.MD +15 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/behavioral_guidelines/security_signoff_and_escalation.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/behavioral_guidelines/security_workflow.md +18 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/examples/security_review_flow.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/policies/risk_acceptance_policy.md +17 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/policies/secrets_and_keys_policy.md +19 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/policies/security_review_policy.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/skills/authn_authz_basics.md +24 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/skills/dependency_and_supply_chain.md +20 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/skills/incident_response_security.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/skills/logging_audit_privacy.md +16 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/skills/secure_architecture_review.md +20 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/skills/secure_coding_review.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/skills/security_engineer_execution.md +28 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/skills/threat_modeling.md +25 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/skills/vulnerability_management.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/security_engineer/workflows/README.md +8 -0
- contextcompass_cli/_package/agent_onboarding/default/story_designer/AGENTS.MD +56 -0
- contextcompass_cli/_package/agent_onboarding/default/story_designer/README.md +45 -0
- contextcompass_cli/_package/agent_onboarding/default/story_designer/SKILLS.MD +44 -0
- contextcompass_cli/_package/agent_onboarding/default/story_designer/WORKFLOWS.MD +15 -0
- contextcompass_cli/_package/agent_onboarding/default/story_designer/behavioral_guidelines/story_designer_workflow.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/story_designer/examples/story_designer_task_flow.md +26 -0
- contextcompass_cli/_package/agent_onboarding/default/story_designer/policies/story_designer_handoff_policy.md +20 -0
- contextcompass_cli/_package/agent_onboarding/default/story_designer/policies/story_designer_quality_policy.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/story_designer/skills/story_designer.md +39 -0
- contextcompass_cli/_package/agent_onboarding/default/story_designer/skills/story_designer_advanced_context.md +17 -0
- contextcompass_cli/_package/agent_onboarding/default/story_designer/skills/story_designer_deliverables.md +28 -0
- contextcompass_cli/_package/agent_onboarding/default/story_designer/skills/story_designer_execution.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/story_designer/workflows/README.md +8 -0
- contextcompass_cli/_package/agent_onboarding/default/story_novel_artist/AGENTS.MD +56 -0
- contextcompass_cli/_package/agent_onboarding/default/story_novel_artist/README.md +45 -0
- contextcompass_cli/_package/agent_onboarding/default/story_novel_artist/SKILLS.MD +44 -0
- contextcompass_cli/_package/agent_onboarding/default/story_novel_artist/WORKFLOWS.MD +15 -0
- contextcompass_cli/_package/agent_onboarding/default/story_novel_artist/behavioral_guidelines/story_novel_artist_workflow.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/story_novel_artist/examples/story_novel_artist_task_flow.md +26 -0
- contextcompass_cli/_package/agent_onboarding/default/story_novel_artist/policies/story_novel_artist_handoff_policy.md +20 -0
- contextcompass_cli/_package/agent_onboarding/default/story_novel_artist/policies/story_novel_artist_quality_policy.md +22 -0
- contextcompass_cli/_package/agent_onboarding/default/story_novel_artist/skills/story_novel_artist.md +39 -0
- contextcompass_cli/_package/agent_onboarding/default/story_novel_artist/skills/story_novel_artist_advanced_context.md +17 -0
- contextcompass_cli/_package/agent_onboarding/default/story_novel_artist/skills/story_novel_artist_deliverables.md +28 -0
- contextcompass_cli/_package/agent_onboarding/default/story_novel_artist/skills/story_novel_artist_execution.md +23 -0
- contextcompass_cli/_package/agent_onboarding/default/story_novel_artist/workflows/README.md +8 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/data_engineer/AGENTS.MD +66 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/data_engineer/SKILLS.MD +15 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/data_engineer/WORKFLOWS.MD +15 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/data_engineer/behavioral_guidelines/data_engineer_behavior_overrides.md +6 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/data_engineer/policies/data_engineer_policy_overrides.md +6 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/data_engineer/profile_overrides.md +9 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/data_engineer/skills/data_engineer_skill_overrides.md +6 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/data_engineer/workflows/README.md +8 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/AGENTS.MD +145 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/SKILLS.MD +37 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/WORKFLOWS.MD +17 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/behavioral_guidelines/synaptic_finishing_developer_behavior_overrides.md +12 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/examples/python/comment_finishing_examples.py +65 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/examples/python/docstring_finishing_examples.py +126 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/examples/python/pytest_component_finishing_examples.py +51 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/examples/python/pytest_integration_finishing_examples.py +59 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/examples/python/pytest_unit_finishing_examples.py +66 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/policies/synaptic_finishing_developer_policy_overrides.md +14 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/profile_overrides.md +17 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/skills/documentation/comment_craft.md +51 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/skills/documentation/docstring_craft.md +86 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/skills/documentation/docstring_test_alignment.md +51 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/skills/documentation/system_aware_docstrings.md +64 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/skills/synaptic_finishing_developer_skill_overrides.md +11 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/skills/testing/component_tests.md +45 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/skills/testing/evidence_reporting.md +25 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/skills/testing/mocking.md +35 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/skills/testing/pytest_integration.md +32 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/skills/testing/pytest_unit.md +49 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/skills/testing/regression_tests.md +24 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/skills/testing/testing_overview.md +71 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/workflows/README.md +8 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/workflows/optimize_pytests_for_repo.md +272 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_finishing_developer/workflows/polish_repo_documentation.md +247 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/AGENTS.MD +386 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/README.md +31 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/SKILLS.MD +44 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/WORKFLOWS.MD +16 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/behavioral_guidelines/synaptic_behavior_overrides.md +17 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/examples/python/anti_patterns.py +19 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/examples/python/cleanup_patterns.py +22 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/examples/python/docstrings.py +19 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/examples/python/logging_patterns.py +11 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/examples/python/protocols_and_abc.py +15 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/examples/python/pytest_component_examples.py +15 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/examples/python/pytest_integration_examples.py +17 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/examples/python/pytest_unit_examples.py +13 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/policies/synaptic_policy_overrides.md +22 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/profile_overrides.md +27 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/python/attribute_aliasing_skill_benchmark.py +35 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/python/banned_patterns.md +110 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/python/cleanup_and_disposal.md +79 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/python/comments.md +39 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/python/docstrings.md +90 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/python/error_model.md +28 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/python/hot_path_attribute_aliasing.md +52 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/python/init_and_ownership.md +35 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/python/interfaces.md +47 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/python/logging.md +37 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/python/module_scope.md +38 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/python/refactor_limits.md +44 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/python/typing.md +52 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/synaptic_skill_overrides.md +24 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/testing/evidence_reporting.md +35 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/testing/mocking.md +31 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/testing/pytest_integration.md +36 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/testing/pytest_unit.md +42 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/testing/regression_tests.md +26 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/skills/testing/testing_overview.md +196 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/workflows/README.md +8 -0
- contextcompass_cli/_package/agent_onboarding/user_defined/synaptic_python_developer/workflows/synaptic_python_developer_onboarding.md +226 -0
- contextcompass_cli/_package/artifact_board.md +64 -0
- contextcompass_cli/_package/artifacts/IMPORTANT_CONSIDERATION.md +43 -0
- contextcompass_cli/_package/artifacts/README.md +41 -0
- contextcompass_cli/_package/attention_board.md +79 -0
- contextcompass_cli/_package/config/context_compass_config.yaml +101 -0
- contextcompass_cli/_package/context_management/README.md +21 -0
- contextcompass_cli/_package/context_management/artifacts/.gitkeep +1 -0
- contextcompass_cli/_package/context_management/context_artifact_template.md +42 -0
- contextcompass_cli/_package/context_management/context_board.md +27 -0
- contextcompass_cli/_package/examples/adr_example.md +29 -0
- contextcompass_cli/_package/examples/artifact_workflow.md +20 -0
- contextcompass_cli/_package/examples/continuity_fact_checker_task_flow.md +23 -0
- contextcompass_cli/_package/examples/design_task_flow.md +35 -0
- contextcompass_cli/_package/examples/developmental_editor_task_flow.md +22 -0
- contextcompass_cli/_package/examples/draft_writer_task_flow.md +23 -0
- contextcompass_cli/_package/examples/eng_task_flow.md +31 -0
- contextcompass_cli/_package/examples/example_architecture/.gitkeep +0 -0
- contextcompass_cli/_package/examples/example_architecture/src_architecture.md +136 -0
- contextcompass_cli/_package/examples/example_architecture/src_architecture_index.md +46 -0
- contextcompass_cli/_package/examples/example_architecture/tests_architecture.md +148 -0
- contextcompass_cli/_package/examples/example_architecture/tests_architecture_index.md +46 -0
- contextcompass_cli/_package/examples/example_completed/.gitkeep +0 -0
- contextcompass_cli/_package/examples/example_completed/2026-02-19_context_compass_release_overview_artifact.md +33 -0
- contextcompass_cli/_package/examples/example_components/.gitkeep +0 -0
- contextcompass_cli/_package/examples/example_components/src_components.md +169 -0
- contextcompass_cli/_package/examples/example_components/src_components_index.md +44 -0
- contextcompass_cli/_package/examples/example_components/tests_components.md +96 -0
- contextcompass_cli/_package/examples/example_components/tests_components_index.md +42 -0
- contextcompass_cli/_package/examples/example_epics/.gitkeep +0 -0
- contextcompass_cli/_package/examples/example_epics/2026-02-19_context_compass_release_readiness_example_pack_epic.md +130 -0
- contextcompass_cli/_package/examples/example_graph_details/README.md +131 -0
- contextcompass_cli/_package/examples/example_graph_details/src/example/__init__.py +4 -0
- contextcompass_cli/_package/examples/example_graph_details/src/example/core/interfaces.py +10 -0
- contextcompass_cli/_package/examples/example_graph_details/src/example/core/resource.py +15 -0
- contextcompass_cli/_package/examples/example_graph_details/src/example/pipeline/pipeline.py +20 -0
- contextcompass_cli/_package/examples/example_graph_details/src/example/pipeline/stage.py +11 -0
- contextcompass_cli/_package/examples/example_graph_details/src/example/storage/store.py +20 -0
- contextcompass_cli/_package/examples/example_graph_details/src_graph.md +192 -0
- contextcompass_cli/_package/examples/example_graph_details/src_graph_index.md +32 -0
- contextcompass_cli/_package/examples/example_stories/.gitkeep +0 -0
- contextcompass_cli/_package/examples/example_stories/2026-02-19_context_compass_release_readiness_examples_story.md +120 -0
- contextcompass_cli/_package/examples/example_tasks/.gitkeep +0 -0
- contextcompass_cli/_package/examples/example_tasks/2026-02-19_context_compass_release_readiness_pack_task.md +147 -0
- contextcompass_cli/_package/examples/line_copy_editor_task_flow.md +23 -0
- contextcompass_cli/_package/examples/platform_task_flow.md +26 -0
- contextcompass_cli/_package/examples/proofreader_task_flow.md +23 -0
- contextcompass_cli/_package/examples/qa_task_flow.md +26 -0
- contextcompass_cli/_package/examples/repo_overview.md +63 -0
- contextcompass_cli/_package/examples/researcher_task_flow.md +23 -0
- contextcompass_cli/_package/examples/security_review_flow.md +24 -0
- contextcompass_cli/_package/examples/story_designer_task_flow.md +23 -0
- contextcompass_cli/_package/examples/story_novel_artist_task_flow.md +22 -0
- contextcompass_cli/_package/mailbox_board.md +79 -0
- contextcompass_cli/_package/special_instructions/README.md +16 -0
- contextcompass_cli/_package/system_docs/.gitkeep +0 -0
- contextcompass_cli/_package/system_docs/patches/active/README.md +25 -0
- contextcompass_cli/_package/system_docs/patches/active/_template_patch_id/architecture_patch.md +53 -0
- contextcompass_cli/_package/system_docs/patches/active/_template_patch_id/code_description_patch_TEMPLATE_COMPONENT.md +39 -0
- contextcompass_cli/_package/system_docs/patches/active/_template_patch_id/component_patch_TEMPLATE_COMPONENT.md +48 -0
- contextcompass_cli/_package/system_docs/system_docs_read_first.md +107 -0
- contextcompass_cli/_package/templates/epic_template.md +149 -0
- contextcompass_cli/_package/templates/story_template.md +131 -0
- contextcompass_cli/_package/templates/task_template.md +124 -0
- contextcompass_cli/_package/templates/workflow_advanced_template.md +111 -0
- contextcompass_cli/_package/templates/workflow_simple_template.md +65 -0
- contextcompass_cli/_package/tickets/README.md +24 -0
- contextcompass_cli/_package/tickets/epics/README.md +68 -0
- contextcompass_cli/_package/tickets/epics/archive/.gitkeep +0 -0
- contextcompass_cli/_package/tickets/epics/backlog/.gitkeep +0 -0
- contextcompass_cli/_package/tickets/epics/completed/.gitkeep +0 -0
- contextcompass_cli/_package/tickets/stories/README.md +68 -0
- contextcompass_cli/_package/tickets/stories/archive/.gitkeep +0 -0
- contextcompass_cli/_package/tickets/stories/backlog/.gitkeep +0 -0
- contextcompass_cli/_package/tickets/stories/completed/.gitkeep +0 -0
- contextcompass_cli/_package/tickets/tasks/README.md +67 -0
- contextcompass_cli/_package/tickets/tasks/archive/.gitkeep +0 -0
- contextcompass_cli/_package/tickets/tasks/backlog/.gitkeep +0 -0
- contextcompass_cli/_package/tickets/tasks/completed/.gitkeep +0 -0
- contextcompass_cli/_package/tools/build_llm_full.py +307 -0
- contextcompass_cli/_package/tools/cleanup_context_compass.py +488 -0
- contextcompass_cli/_package/tools/migrate_boards.py +218 -0
- contextcompass_cli/_package/tools/package_manifest.py +351 -0
- contextcompass_cli/_package/tools/system_documents/index_document.py +476 -0
- contextcompass_cli/_package/tools/system_documents/python/assemble_graph.py +387 -0
- contextcompass_cli/_package/tools/system_documents/python/extract_graph.py +626 -0
- contextcompass_cli/_package/tools/system_documents/python/graph_semantics_tickets.py +405 -0
- contextcompass_cli/_package/tools/system_documents/python/graph_walker.py +375 -0
- contextcompass_cli/_package/tools/system_documents/python/migrate_authored_graph.py +179 -0
- contextcompass_cli/_package/tools/update_context_compass.py +511 -0
- contextcompass_cli/_package/user_defined/README.md +49 -0
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
# Example src_components (repo-grounded)
|
|
2
|
+
|
|
3
|
+
## Metadata
|
|
4
|
+
- Example type: high-fidelity C3/C2/C1 map
|
|
5
|
+
- Objective: demonstrate complete component entries based on this repository
|
|
6
|
+
- Last verified at: 2026-08-01T16:16:14Z
|
|
7
|
+
|
|
8
|
+
## Scope
|
|
9
|
+
Provide a concrete component-map example for ticket-first execution using real
|
|
10
|
+
files from this package.
|
|
11
|
+
|
|
12
|
+
## Indexing
|
|
13
|
+
|
|
14
|
+
This document is authored. Its only generated companion is `src_components_index.md`,
|
|
15
|
+
rebuilt in the same pass as any edit:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
python context_compass/tools/system_documents/index_document.py \
|
|
19
|
+
--doc context_compass/examples/example_components/src_components.md
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
That command indexes THIS example, and it works - run it and compare the
|
|
23
|
+
output to the `src_components_index.md` beside it. When you write your own, the
|
|
24
|
+
target becomes `context_compass/system_docs/src_components.md`, which does not exist
|
|
25
|
+
until you create it: the package ships `system_docs/` empty.
|
|
26
|
+
|
|
27
|
+
Format rules the index depends on, demonstrated throughout this example:
|
|
28
|
+
- exactly one H1 (the document title)
|
|
29
|
+
- the navigable unit is H3 `### Component: <Name>`, at consistent depth
|
|
30
|
+
- section names unique and stable - index rows are selected by name
|
|
31
|
+
- container headings organise, but are never the read target: a heading wrapping
|
|
32
|
+
only other headings indexes as a range covering all of them
|
|
33
|
+
|
|
34
|
+
Spec: `agent_onboarding/default/engineer/skills/system_document_build.md`
|
|
35
|
+
|
|
36
|
+
## DO NOT ASSUME / Unknowns Gate
|
|
37
|
+
- unresolved behavior stays UNKNOWN
|
|
38
|
+
- promote claims only with evidence-backed references
|
|
39
|
+
|
|
40
|
+
## Unknowns
|
|
41
|
+
- UNKNOWN: future split of closure-sync responsibilities between docs policy and
|
|
42
|
+
scripted automation.
|
|
43
|
+
|
|
44
|
+
## C3 Components Catalog
|
|
45
|
+
### Component: Router/Role Resolver
|
|
46
|
+
- Purpose: map the selected role to a deterministic role-chain readset.
|
|
47
|
+
- Responsibilities: read `SKILLS.MD`, resolve role path, enforce parent-first
|
|
48
|
+
chain.
|
|
49
|
+
- Inputs: the registry table in `SKILLS.MD`.
|
|
50
|
+
- Outputs: ordered `SKILLS.MD` read chain.
|
|
51
|
+
- Owned State: none. The registry table in `SKILLS.MD` is the state;
|
|
52
|
+
`config/context_compass_config.yaml` enumerates no roles.
|
|
53
|
+
- Lifecycle/Cleanup: resolved once per agent per session; nothing persists
|
|
54
|
+
between sessions, so there is no state to clean up.
|
|
55
|
+
- Concurrency/Threading: read-only resolution, safe under concurrent agents.
|
|
56
|
+
Role selection is per agent, so two agents resolving different roles in the
|
|
57
|
+
same repository do not contend.
|
|
58
|
+
- Invariants/Guarantees: deterministic chain order and explicit path mapping.
|
|
59
|
+
- Failure Modes: bad mapping path, stale references.
|
|
60
|
+
- Observability: the resolved chain is stated in the onboarding attestation.
|
|
61
|
+
- Extension Points: add a role by adding one registry row and the `SKILLS.MD`
|
|
62
|
+
it names; no resolver change is required.
|
|
63
|
+
- Key Files (C1): `SKILLS.MD`, `config/context_compass_config.yaml`.
|
|
64
|
+
|
|
65
|
+
### Component: Ticket Microcycle Coordinator
|
|
66
|
+
- Purpose: enforce evidence-backed delivery cadence.
|
|
67
|
+
- Responsibilities: keep note updates, transition logic, and validation records
|
|
68
|
+
coherent.
|
|
69
|
+
- Inputs: active ticket content + findings.
|
|
70
|
+
- Outputs: append-only notes and status transitions.
|
|
71
|
+
- Owned State: ticket `## Notes` and transition records.
|
|
72
|
+
- Lifecycle/Cleanup: spans one ticket, from route to closure; on closure the
|
|
73
|
+
ticket moves to its `completed/` lane rather than being deleted.
|
|
74
|
+
- Concurrency/Threading: single-writer per ticket. Two agents on one ticket is
|
|
75
|
+
a coordination failure, not a supported mode.
|
|
76
|
+
- Invariants/Guarantees: meaningful findings are captured before deeper actions.
|
|
77
|
+
- Failure Modes: undocumented decisions and speculative transitions.
|
|
78
|
+
- Observability: note timestamps and transition records in the ticket itself.
|
|
79
|
+
- Extension Points: the microcycle phases are named in `workflow.md`; a lane
|
|
80
|
+
with extra phases extends that list rather than forking the coordinator.
|
|
81
|
+
- Key Files (C1): `tickets/*`, `templates/task_template.md`, `agent_onboarding/default/general/skills/workflow.md`.
|
|
82
|
+
|
|
83
|
+
### Component: Artifact Link Coordinator
|
|
84
|
+
- Purpose: maintain traceable artifact-to-ticket relationships.
|
|
85
|
+
- Responsibilities: keep artifact paths, status, and disposition synchronized.
|
|
86
|
+
- Inputs: story/task artifact links and closure decisions.
|
|
87
|
+
- Outputs: active/cleared rows in artifact board.
|
|
88
|
+
- Owned State: `artifact_board.md` rows.
|
|
89
|
+
- Lifecycle/Cleanup: a row lives from artifact creation to disposition at
|
|
90
|
+
ticket closure; cleared rows stay as history.
|
|
91
|
+
- Concurrency/Threading: append-oriented board writes; concurrent edits to the
|
|
92
|
+
same row require ticket-level coordination.
|
|
93
|
+
- Invariants/Guarantees: active artifact always has ticket ownership and
|
|
94
|
+
disposition.
|
|
95
|
+
- Failure Modes: orphaned artifact rows, missing disposition.
|
|
96
|
+
- Observability: the active/cleared split on the board is the status surface.
|
|
97
|
+
- Extension Points: new artifact classes add a disposition rule; the row shape
|
|
98
|
+
stays fixed.
|
|
99
|
+
- Key Files (C1): `artifact_board.md`, `examples/example_completed/*`.
|
|
100
|
+
|
|
101
|
+
## C2 Subcomponents Catalog
|
|
102
|
+
- Router/Role Resolver
|
|
103
|
+
- profile selector
|
|
104
|
+
- role path resolver
|
|
105
|
+
- chain-order reader
|
|
106
|
+
|
|
107
|
+
- Ticket Microcycle Coordinator
|
|
108
|
+
- note appender
|
|
109
|
+
- transition recorder
|
|
110
|
+
- validation reporter
|
|
111
|
+
|
|
112
|
+
- Artifact Link Coordinator
|
|
113
|
+
- artifact path linker
|
|
114
|
+
- disposition tracker
|
|
115
|
+
|
|
116
|
+
## Method-Level Call Flows (C1)
|
|
117
|
+
- `resolve_profile() -> resolve_role_path() -> read_inherited_skills()`
|
|
118
|
+
- `investigate() -> append_note(FACT/UNKNOWN) -> plan() -> implement() -> validate() -> append_note(result)`
|
|
119
|
+
- `link_artifact() -> record_disposition() -> verify_link_on_close()`
|
|
120
|
+
|
|
121
|
+
## C1 Code Map (Core)
|
|
122
|
+
- path: `SKILLS.MD`
|
|
123
|
+
start_line: 1
|
|
124
|
+
end_line: 108
|
|
125
|
+
loc: 108
|
|
126
|
+
verified_at: 2026-08-01T16:16:14Z
|
|
127
|
+
- path: `templates/task_template.md`
|
|
128
|
+
start_line: 1
|
|
129
|
+
end_line: 111
|
|
130
|
+
loc: 111
|
|
131
|
+
verified_at: 2026-08-01T16:16:14Z
|
|
132
|
+
- path: `tickets/tasks/README.md`
|
|
133
|
+
start_line: 1
|
|
134
|
+
end_line: 67
|
|
135
|
+
loc: 67
|
|
136
|
+
verified_at: 2026-08-01T16:16:14Z
|
|
137
|
+
- path: `examples/eng_task_flow.md`
|
|
138
|
+
start_line: 1
|
|
139
|
+
end_line: 31
|
|
140
|
+
loc: 31
|
|
141
|
+
verified_at: 2026-08-01T16:16:14Z
|
|
142
|
+
|
|
143
|
+
## Diagrams
|
|
144
|
+
```text
|
|
145
|
+
Profile Config -> Skills Resolver -> Active Ticket -> Notes/Transitions -> Closure
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
```mermaid
|
|
149
|
+
flowchart LR
|
|
150
|
+
P[Profile Config] --> S[Skills Resolver]
|
|
151
|
+
S --> T[Active Ticket]
|
|
152
|
+
T --> N[Notes + Transitions]
|
|
153
|
+
N --> C[Closure Sync]
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
## Information Sources
|
|
157
|
+
- `SKILLS.MD`
|
|
158
|
+
- `config/context_compass_config.yaml`
|
|
159
|
+
- `templates/task_template.md`
|
|
160
|
+
- `tickets/tasks/README.md`
|
|
161
|
+
- `agent_onboarding/default/general/skills/workflow.md`
|
|
162
|
+
- `artifact_board.md`
|
|
163
|
+
|
|
164
|
+
## Context / Handoff Summary
|
|
165
|
+
This example demonstrates expected component-map depth with explicit ownership,
|
|
166
|
+
invariants, and file-backed call flow claims.
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# src_components_index
|
|
2
|
+
|
|
3
|
+
Line ranges into `src_components.md`. Derived: regenerated by re-walking the
|
|
4
|
+
document, never hand-edited. Hand-editing a range is how an index starts
|
|
5
|
+
lying.
|
|
6
|
+
|
|
7
|
+
Line numbers are 1-based and inclusive on both ends.
|
|
8
|
+
|
|
9
|
+
## Staleness proof
|
|
10
|
+
|
|
11
|
+
| field | value |
|
|
12
|
+
| --- | --- |
|
|
13
|
+
| document | `src_components.md` |
|
|
14
|
+
| index_version | 1.1.0 |
|
|
15
|
+
| generated_at | 2026-08-01T23:32:17Z |
|
|
16
|
+
| line_count | 169 |
|
|
17
|
+
| line_ending | lf |
|
|
18
|
+
| content_sha256 | `518dd137c426620f9244c8ada040f4adf4bbf5092276ba840af872b517d448ec` |
|
|
19
|
+
| sections | 15 |
|
|
20
|
+
|
|
21
|
+
Recompute all three of `line_count`, `line_ending`, and `content_sha256`
|
|
22
|
+
before slicing. On any mismatch: STOP, do not slice, do not eyeball an
|
|
23
|
+
offset. Regenerate this index or read the document directly, and say
|
|
24
|
+
which you did.
|
|
25
|
+
|
|
26
|
+
## Sections
|
|
27
|
+
|
|
28
|
+
| lines | lvl | name |
|
|
29
|
+
| --- | --- | --- |
|
|
30
|
+
| 3-7 | 2 | Metadata |
|
|
31
|
+
| 8-11 | 2 | Scope |
|
|
32
|
+
| 12-35 | 2 | Indexing |
|
|
33
|
+
| 36-39 | 2 | DO NOT ASSUME / Unknowns Gate |
|
|
34
|
+
| 40-43 | 2 | Unknowns |
|
|
35
|
+
| 44-100 | 2 | C3 Components Catalog |
|
|
36
|
+
| 45-64 | 3 | C3 Components Catalog > Component: Router/Role Resolver |
|
|
37
|
+
| 65-82 | 3 | C3 Components Catalog > Component: Ticket Microcycle Coordinator |
|
|
38
|
+
| 83-100 | 3 | C3 Components Catalog > Component: Artifact Link Coordinator |
|
|
39
|
+
| 101-115 | 2 | C2 Subcomponents Catalog |
|
|
40
|
+
| 116-120 | 2 | Method-Level Call Flows (C1) |
|
|
41
|
+
| 121-142 | 2 | C1 Code Map (Core) |
|
|
42
|
+
| 143-155 | 2 | Diagrams |
|
|
43
|
+
| 156-163 | 2 | Information Sources |
|
|
44
|
+
| 164-169 | 2 | Context / Handoff Summary |
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
# Example tests_components
|
|
2
|
+
|
|
3
|
+
## Metadata
|
|
4
|
+
- Example only; demonstrates tests component mapping format.
|
|
5
|
+
|
|
6
|
+
## Scope
|
|
7
|
+
Map key test-validation components for workflow integrity.
|
|
8
|
+
|
|
9
|
+
## Indexing
|
|
10
|
+
|
|
11
|
+
This document is authored. Its only generated companion is `tests_components_index.md`,
|
|
12
|
+
rebuilt in the same pass as any edit:
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
python context_compass/tools/system_documents/index_document.py \
|
|
16
|
+
--doc context_compass/examples/example_components/tests_components.md
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
That command indexes THIS example, and it works - run it and compare the
|
|
20
|
+
output to the `tests_components_index.md` beside it. When you write your own, the
|
|
21
|
+
target becomes `context_compass/system_docs/tests_components.md`, which does not exist
|
|
22
|
+
until you create it: the package ships `system_docs/` empty.
|
|
23
|
+
|
|
24
|
+
Format rules the index depends on, demonstrated throughout this example:
|
|
25
|
+
- exactly one H1 (the document title)
|
|
26
|
+
- the navigable unit is H3 `### Component: <Name>`, at consistent depth
|
|
27
|
+
- section names unique and stable - index rows are selected by name
|
|
28
|
+
- container headings organise, but are never the read target: a heading wrapping
|
|
29
|
+
only other headings indexes as a range covering all of them
|
|
30
|
+
|
|
31
|
+
Spec: `agent_onboarding/default/engineer/skills/system_document_build.md`
|
|
32
|
+
|
|
33
|
+
## DO NOT ASSUME / Unknowns Gate
|
|
34
|
+
Keep unresolved test assumptions as UNKNOWN.
|
|
35
|
+
|
|
36
|
+
## Unknowns
|
|
37
|
+
- UNKNOWN: final CI matrix for multi-runtime validation.
|
|
38
|
+
|
|
39
|
+
## C3 Components Catalog
|
|
40
|
+
### Component: Reference Integrity Scanner
|
|
41
|
+
- Purpose: detect broken internal references.
|
|
42
|
+
- Responsibilities: scan docs and resolve paths.
|
|
43
|
+
- Inputs: markdown/yaml files.
|
|
44
|
+
- Outputs: missing reference findings.
|
|
45
|
+
- Owned State: scan report.
|
|
46
|
+
- Lifecycle/Cleanup: run on release hardening.
|
|
47
|
+
- Concurrency/Threading: serial scan pass.
|
|
48
|
+
- Invariants/Guarantees: findings include file references.
|
|
49
|
+
- Failure Modes: false negatives from incomplete patterns. A pattern narrower
|
|
50
|
+
than the file set it claims to cover reports a clean sweep over a subset,
|
|
51
|
+
which is worse than reporting nothing.
|
|
52
|
+
- Observability: ticket validation notes.
|
|
53
|
+
- Extension Points: new reference shapes extend the resolver's match set; the
|
|
54
|
+
finding format stays fixed so downstream triage does not change.
|
|
55
|
+
- Key Files (C1): `tickets/*/README.md`, `templates/*.md`.
|
|
56
|
+
|
|
57
|
+
## C2 Subcomponents Catalog
|
|
58
|
+
- path resolver
|
|
59
|
+
- missing-target reporter
|
|
60
|
+
- severity triage layer
|
|
61
|
+
|
|
62
|
+
## Method-Level Call Flows (C1)
|
|
63
|
+
- `scan_files -> resolve_targets -> emit_findings`
|
|
64
|
+
- `triage_findings -> gate_release`
|
|
65
|
+
|
|
66
|
+
## C1 Code Map (Core)
|
|
67
|
+
- path: `examples/example_graph_details/src/example/core/resource.py`
|
|
68
|
+
start_line: 1
|
|
69
|
+
end_line: 15
|
|
70
|
+
loc: 15
|
|
71
|
+
verified_at: 2026-08-01T16:16:14Z
|
|
72
|
+
- path: `examples/example_graph_details/src/example/storage/store.py`
|
|
73
|
+
start_line: 1
|
|
74
|
+
end_line: 20
|
|
75
|
+
loc: 20
|
|
76
|
+
verified_at: 2026-08-01T16:16:14Z
|
|
77
|
+
|
|
78
|
+
## Diagrams
|
|
79
|
+
```text
|
|
80
|
+
Docs -> Scanner -> Findings -> Release Gate
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
```mermaid
|
|
84
|
+
flowchart LR
|
|
85
|
+
D[Docs] --> S[Scanner]
|
|
86
|
+
S --> F[Findings]
|
|
87
|
+
F --> G[Release Gate]
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
## Information Sources
|
|
91
|
+
- `templates/*.md`
|
|
92
|
+
- `tickets/*/README.md`
|
|
93
|
+
- `agent_onboarding/default/qa_engineer/skills/*`
|
|
94
|
+
|
|
95
|
+
## Context / Handoff Summary
|
|
96
|
+
Use this structure when mapping real test components.
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# tests_components_index
|
|
2
|
+
|
|
3
|
+
Line ranges into `tests_components.md`. Derived: regenerated by re-walking the
|
|
4
|
+
document, never hand-edited. Hand-editing a range is how an index starts
|
|
5
|
+
lying.
|
|
6
|
+
|
|
7
|
+
Line numbers are 1-based and inclusive on both ends.
|
|
8
|
+
|
|
9
|
+
## Staleness proof
|
|
10
|
+
|
|
11
|
+
| field | value |
|
|
12
|
+
| --- | --- |
|
|
13
|
+
| document | `tests_components.md` |
|
|
14
|
+
| index_version | 1.1.0 |
|
|
15
|
+
| generated_at | 2026-08-02T10:58:15Z |
|
|
16
|
+
| line_count | 96 |
|
|
17
|
+
| line_ending | lf |
|
|
18
|
+
| content_sha256 | `d505f573cd2b96f8df2169ab8640297c2f7f0c64fb4898e4f2aeebec14c4b634` |
|
|
19
|
+
| sections | 13 |
|
|
20
|
+
|
|
21
|
+
Recompute all three of `line_count`, `line_ending`, and `content_sha256`
|
|
22
|
+
before slicing. On any mismatch: STOP, do not slice, do not eyeball an
|
|
23
|
+
offset. Regenerate this index or read the document directly, and say
|
|
24
|
+
which you did.
|
|
25
|
+
|
|
26
|
+
## Sections
|
|
27
|
+
|
|
28
|
+
| lines | lvl | name |
|
|
29
|
+
| --- | --- | --- |
|
|
30
|
+
| 3-5 | 2 | Metadata |
|
|
31
|
+
| 6-8 | 2 | Scope |
|
|
32
|
+
| 9-32 | 2 | Indexing |
|
|
33
|
+
| 33-35 | 2 | DO NOT ASSUME / Unknowns Gate |
|
|
34
|
+
| 36-38 | 2 | Unknowns |
|
|
35
|
+
| 39-56 | 2 | C3 Components Catalog |
|
|
36
|
+
| 40-56 | 3 | C3 Components Catalog > Component: Reference Integrity Scanner |
|
|
37
|
+
| 57-61 | 2 | C2 Subcomponents Catalog |
|
|
38
|
+
| 62-65 | 2 | Method-Level Call Flows (C1) |
|
|
39
|
+
| 66-77 | 2 | C1 Code Map (Core) |
|
|
40
|
+
| 78-89 | 2 | Diagrams |
|
|
41
|
+
| 90-94 | 2 | Information Sources |
|
|
42
|
+
| 95-96 | 2 | Context / Handoff Summary |
|
|
File without changes
|
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
# Epic: Context Compass Release Readiness Example Pack
|
|
2
|
+
|
|
3
|
+
## Metadata
|
|
4
|
+
- Epic ID: EPIC-2026-02-19-context-compass-release-readiness-example-pack
|
|
5
|
+
- Status: review
|
|
6
|
+
- Owner: context_compass_maintainer
|
|
7
|
+
- Priority: p1
|
|
8
|
+
- Created: 2026-02-19T00:00:00Z
|
|
9
|
+
- Updated: 2026-02-19T03:10:00Z
|
|
10
|
+
- Target Window: 2026-Q1
|
|
11
|
+
- Related Program/Initiative: public-library-release-hardening
|
|
12
|
+
|
|
13
|
+
## Problem / Opportunity
|
|
14
|
+
Top-level examples were shallow and referenced an unrelated legacy narrative.
|
|
15
|
+
Users could not follow a complete epic -> story -> task flow grounded in this
|
|
16
|
+
repository.
|
|
17
|
+
|
|
18
|
+
## MRP Alignment (Most Reasonable Product)
|
|
19
|
+
The durable core is a repo-local example set that demonstrates real usage:
|
|
20
|
+
entrypoints and routing, template-complete tickets, artifact lifecycle, and
|
|
21
|
+
compaction-safe handoff notes.
|
|
22
|
+
|
|
23
|
+
## Ticket Contract
|
|
24
|
+
- ENTRY_GATE: `SKILLS.MD` and `AGENTS.MD` are present and readable.
|
|
25
|
+
- EXECUTION_BOUNDARY: docs/examples only.
|
|
26
|
+
- DEPENDENCIES: `templates/*_template.md`, `tickets/*/README.md`, `agent_onboarding/default/general/skills/workflow.md`.
|
|
27
|
+
- EXIT_GATE: complete example epic/story/task exists under `examples/example_*`; flow docs and system docs are aligned.
|
|
28
|
+
- FAILURE_ESCALATION: raise `DECISION_REQUEST` for ambiguity and `BLOCKER` for unresolved references.
|
|
29
|
+
|
|
30
|
+
## Goals (Outcomes)
|
|
31
|
+
- Build one complete, high-quality epic/story/task chain based on this repo.
|
|
32
|
+
- Publish a rich overview for users copying `context_compass/`.
|
|
33
|
+
- Ensure top-level example flows reference only real example assets.
|
|
34
|
+
|
|
35
|
+
## Non-Goals (Explicit Exclusions)
|
|
36
|
+
- No runtime code changes.
|
|
37
|
+
- No policy semantics redesign.
|
|
38
|
+
|
|
39
|
+
## Scope Boundaries
|
|
40
|
+
- In scope:
|
|
41
|
+
- `examples/example_epics/`, `examples/example_stories/`, `examples/example_tasks/`, `examples/example_completed/`
|
|
42
|
+
- `examples/eng_task_flow.md`, `examples/design_task_flow.md`, `examples/artifact_workflow.md`, `examples/adr_example.md`, `examples/repo_overview.md`
|
|
43
|
+
- `system_docs/src_architecture.md`, `system_docs/src_components.md`
|
|
44
|
+
- Out of scope:
|
|
45
|
+
- CI/release scripting changes
|
|
46
|
+
- role-policy refactors
|
|
47
|
+
|
|
48
|
+
## State Transition Event
|
|
49
|
+
- from_state: in_progress
|
|
50
|
+
- to_state: review
|
|
51
|
+
- transition_reason: story and task are complete; awaiting user acceptance.
|
|
52
|
+
|
|
53
|
+
## Success Metrics
|
|
54
|
+
- Full example chain exists and links correctly.
|
|
55
|
+
- Legacy sample slugs removed from top-level examples.
|
|
56
|
+
- Architecture/components docs use clean, copy-safe paths.
|
|
57
|
+
|
|
58
|
+
## Milestones (Track Progress)
|
|
59
|
+
- [x] Replace weak sample narrative with repo-based chain.
|
|
60
|
+
- [x] Upgrade architecture/components docs with concrete repo grounding.
|
|
61
|
+
- [x] Publish rich overview and flow alignment.
|
|
62
|
+
|
|
63
|
+
## Stories (Required to Complete)
|
|
64
|
+
- [x] Story: STORY-2026-02-19-context-compass-release-readiness-examples - create complete example chain and align docs.
|
|
65
|
+
|
|
66
|
+
## Tasks (Cross-Cutting or Epic-Level)
|
|
67
|
+
- [x] Task: Complete story STORY-2026-02-19-context-compass-release-readiness-examples
|
|
68
|
+
- [x] Task: Verify top-level example references and lane isolation.
|
|
69
|
+
- [x] Task: Verify Ticket Microcycle enforcement across linked ticket docs.
|
|
70
|
+
|
|
71
|
+
## Acceptance Criteria (Epic Done)
|
|
72
|
+
- Example epic/story/task/artifact are present in `examples/example_*` lanes.
|
|
73
|
+
- Rich overview exists in `examples/repo_overview.md`.
|
|
74
|
+
- Top-level flow docs and system docs are coherent and evidence-ready.
|
|
75
|
+
|
|
76
|
+
## Risks / Mitigations
|
|
77
|
+
- Risk: docs drift and links break.
|
|
78
|
+
- Mitigation: run release grep checks for stale slugs and bad path patterns.
|
|
79
|
+
|
|
80
|
+
## Applicable Anti-Patterns
|
|
81
|
+
- [x] No epic-state transition without story-level evidence.
|
|
82
|
+
- [x] No closure while required stories are incomplete or unaccepted.
|
|
83
|
+
- [x] No program claims without source evidence from story/task notes.
|
|
84
|
+
|
|
85
|
+
## Validation / Test Approach
|
|
86
|
+
- `rg -n "context_compass_release_readiness|repo_overview" examples`
|
|
87
|
+
- `rg -n "context_compass/AGENTS.MD" examples`
|
|
88
|
+
- `rg -n "\x07|\x08|\x09|\x0d" system_docs examples/example_architecture examples/example_components`
|
|
89
|
+
|
|
90
|
+
## Artifact Links (Optional)
|
|
91
|
+
- ARTIFACTS_REQUIRED: true
|
|
92
|
+
- ARTIFACT_PATHS:
|
|
93
|
+
- `examples/example_completed/2026-02-19_context_compass_release_overview_artifact.md`
|
|
94
|
+
- DISPOSITION: retain_as_reference
|
|
95
|
+
- CLEANUP_TRIGGER: next docs refresh cycle.
|
|
96
|
+
|
|
97
|
+
## Notes
|
|
98
|
+
- DATETIME: 2026-02-19T02:40:00Z
|
|
99
|
+
TYPE: FACT
|
|
100
|
+
CLAIM: top-level examples were not repository-grounded and lacked full ticket-chain depth.
|
|
101
|
+
EVIDENCE:
|
|
102
|
+
- `examples/eng_task_flow.md:1-30`
|
|
103
|
+
- `examples/adr_example.md:1-20`
|
|
104
|
+
IMPACT: poor onboarding and weak handoff reliability.
|
|
105
|
+
NEXT: replace with complete repo-based examples.
|
|
106
|
+
REREAD: REQUIRED
|
|
107
|
+
SCORE_0_TO_10: 9
|
|
108
|
+
- DATETIME: 2026-02-19T03:10:00Z
|
|
109
|
+
TYPE: FACT
|
|
110
|
+
CLAIM: new example chain and rich overview are in place and linked.
|
|
111
|
+
EVIDENCE:
|
|
112
|
+
- `examples/example_stories/2026-02-19_context_compass_release_readiness_examples_story.md:1-170`
|
|
113
|
+
- `examples/example_tasks/2026-02-19_context_compass_release_readiness_pack_task.md:1-200`
|
|
114
|
+
- `examples/repo_overview.md:1-130`
|
|
115
|
+
IMPACT: public users can follow a complete, repo-native workflow.
|
|
116
|
+
NEXT: request user acceptance and close.
|
|
117
|
+
REREAD: HELPFUL
|
|
118
|
+
SCORE_0_TO_10: 9
|
|
119
|
+
|
|
120
|
+
## Closure Confirmation
|
|
121
|
+
- [x] Work walkthrough shared with user
|
|
122
|
+
- [ ] Acceptance criteria confirmed by user
|
|
123
|
+
- [x] Applicable anti-pattern checks are clear or escalated with evidence.
|
|
124
|
+
|
|
125
|
+
## Context / Handoff Summary
|
|
126
|
+
This epic now anchors a full repo-based example workflow under `examples/`.
|
|
127
|
+
Story and task are complete; only user acceptance remains for closure.
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
# example_graph_details
|
|
2
|
+
|
|
3
|
+
Shape reference for the generated source graph.
|
|
4
|
+
|
|
5
|
+
The graph is **derived from source code**, not authored. Two files are produced
|
|
6
|
+
by `tools/system_documents/python/`, and neither ships in `system_docs/` - a
|
|
7
|
+
fresh install has neither, and that is expected:
|
|
8
|
+
|
|
9
|
+
- `system_docs/src_graph.md` - one section per source file
|
|
10
|
+
- `system_docs/src_graph_index.md` - line ranges into it, plus staleness proof
|
|
11
|
+
|
|
12
|
+
## This example is reproducible
|
|
13
|
+
|
|
14
|
+
`src/example/` here is a real six-file Python package, and `src_graph.md` /
|
|
15
|
+
`src_graph_index.md` are the unmodified output of running the real pipeline over
|
|
16
|
+
it. Nothing was hand-written, trimmed, or annotated afterwards.
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
cd context_compass/examples/example_graph_details
|
|
20
|
+
python ../../tools/system_documents/python/extract_graph.py --src src --out /tmp/desc
|
|
21
|
+
python ../../tools/system_documents/python/assemble_graph.py --descriptors /tmp/desc --out /tmp/out
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
The result matches what ships here, except for the authored fields - those are
|
|
25
|
+
tier 3 and were added to the descriptors by hand, which is exactly the documented
|
|
26
|
+
workflow. That is the point of the example: it shows both what the extractor
|
|
27
|
+
recovers and what a human has to supply.
|
|
28
|
+
|
|
29
|
+
Because the output is unmodified, **the index actually proves the document**.
|
|
30
|
+
Recompute `line_count` and `content_sha256` over `src_graph.md` and they match
|
|
31
|
+
the staleness proof, and every range lands on its own `BEGIN FILE` / `END FILE`
|
|
32
|
+
delimiter. An example you can verify is worth more than one you have to trust.
|
|
33
|
+
|
|
34
|
+
## What a section looks like
|
|
35
|
+
|
|
36
|
+
Each source file gets one section, delimited by HTML comments naming the file.
|
|
37
|
+
Line ranges for every section live in the index; read the index and slice, never
|
|
38
|
+
scan the document for delimiters.
|
|
39
|
+
|
|
40
|
+
The `BEGIN FILE` / `END FILE` comments are the section boundaries. They do not
|
|
41
|
+
render, and the index's ranges are measured against them - a section written
|
|
42
|
+
without them is not addressable.
|
|
43
|
+
|
|
44
|
+
See `src_graph.md` lines 80-124 for the richest section: a class with derived
|
|
45
|
+
and authored edges, authored semantics, and unconfirmed candidates side by side.
|
|
46
|
+
|
|
47
|
+
## What is derived and what is authored
|
|
48
|
+
|
|
49
|
+
This distinction is the whole contract. Measured against a hand-authored graph
|
|
50
|
+
of 535 nodes and 997 edges:
|
|
51
|
+
|
|
52
|
+
| field | origin | recovery |
|
|
53
|
+
|---|---|---|
|
|
54
|
+
| `id`, `label`, `kind`, `file`, `lineno`, `bases`, `public_methods` | derived | 94% |
|
|
55
|
+
| `specializes`, `implements` | derived | 94%, targets resolved 99% |
|
|
56
|
+
| `creates` | **candidate only** | 57%, over-generated ~8x |
|
|
57
|
+
| `role`, `responsibilities`, `owns_state`, `phases` | authored | not derivable |
|
|
58
|
+
| `owns_lifecycle_of`, `uses`, `borrows` | authored | **not derivable** |
|
|
59
|
+
|
|
60
|
+
`owns_lifecycle_of`, `uses`, and `borrows` are syntactically identical - each is
|
|
61
|
+
"A holds a reference to B". Which one it is, is a design fact that appears
|
|
62
|
+
nowhere in the source text. That is 68% of all edges, and it is why the graph has
|
|
63
|
+
an authored layer at all.
|
|
64
|
+
|
|
65
|
+
You can see it in this example. `Pipeline` holds a `Stage` list and a `Store`
|
|
66
|
+
reference. The AST shows both as attributes; only a human knows the pipeline owns
|
|
67
|
+
its stages and borrows the store. The extractor emitted neither edge.
|
|
68
|
+
|
|
69
|
+
And because the claim is authored, the reason is shown next to it:
|
|
70
|
+
|
|
71
|
+
```
|
|
72
|
+
| `..Pipeline` | owns_lifecycle_of | `..Stage` | one_to_many | init,runtime,cleanup | authored |
|
|
73
|
+
| `..Pipeline` | borrows | `..Store` | many_to_one | runtime | authored |
|
|
74
|
+
|
|
75
|
+
- `..Pipeline` -> `..Stage`: Pipeline constructs its stages in __init__ and is the
|
|
76
|
+
only object that can release them, so the stage list dies with the run.
|
|
77
|
+
- `..Pipeline` -> `..Store`: The store is passed in and outlives the pipeline.
|
|
78
|
+
Releasing the pipeline must not close it - several pipelines share one store.
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
Derived rows carry `-` in the authored columns. That is not missing data: it is
|
|
82
|
+
the graph saying nobody has authored that relationship's semantics yet.
|
|
83
|
+
|
|
84
|
+
`why` sits beneath the table rather than in it, so the table stays scannable. On
|
|
85
|
+
this example the whole authored layer costs 3 lines out of 192, and you never pay
|
|
86
|
+
it on a read you did not ask for - you slice one section, not the document.
|
|
87
|
+
|
|
88
|
+
A node marked **UNSEMANTIC** carries mechanical scaffold and no meaning yet. Its
|
|
89
|
+
structure is trustworthy; do not infer its purpose from its name.
|
|
90
|
+
|
|
91
|
+
## Two index shapes, do not confuse them
|
|
92
|
+
|
|
93
|
+
`src_graph.md` is GENERATED, so its index is emitted by `assemble_graph.py` in
|
|
94
|
+
the same pass - keyed by **source path**. Authored documents get their index from
|
|
95
|
+
`index_document.py` by walking headings - keyed by **heading breadcrumb**.
|
|
96
|
+
|
|
97
|
+
Running `index_document.py` against `src_graph.md` produces a heading-shaped
|
|
98
|
+
index of `## src/...` and `### Nodes` sections. It parses, but it is the wrong
|
|
99
|
+
artifact: it indexes the rendering rather than the files, and every section named
|
|
100
|
+
`Nodes` collides. The tool will warn about the collision.
|
|
101
|
+
|
|
102
|
+
## Index shape
|
|
103
|
+
|
|
104
|
+
```markdown
|
|
105
|
+
| lines | source | nodes | edges |
|
|
106
|
+
| --- | --- | --- | --- |
|
|
107
|
+
| 11-26 | `src/example/__init__.py` | 1 | 0 |
|
|
108
|
+
| 80-124 | `src/example/pipeline/pipeline.py` | 2 | 3 |
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
The `edges` count covers derived and authored edges together, matching what that
|
|
112
|
+
section's `Edges out` table renders. Candidates are not counted - they are
|
|
113
|
+
guesses, not edges.
|
|
114
|
+
|
|
115
|
+
Every row is keyed by a name - here the source path. No index in this system uses
|
|
116
|
+
a bare number as identity: a row keyed by a number tells a reader nothing about
|
|
117
|
+
whether to read it.
|
|
118
|
+
|
|
119
|
+
## Files here
|
|
120
|
+
|
|
121
|
+
- `src/example/` - a six-file Python package, the input
|
|
122
|
+
- `src_graph.md` - unmodified assembler output over that package
|
|
123
|
+
- `src_graph_index.md` - unmodified index from the same pass
|
|
124
|
+
- this README
|
|
125
|
+
|
|
126
|
+
## References
|
|
127
|
+
|
|
128
|
+
- `agent_onboarding/default/engineer/skills/src_graph_generation.md` - building
|
|
129
|
+
- `agent_onboarding/default/engineer/skills/src_graph_usage.md` - reading
|
|
130
|
+
- `agent_onboarding/default/engineer/skills/system_document_build.md` -
|
|
131
|
+
the authored documents and their indexes
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
"""Structural mirrors of the core contracts."""
|
|
2
|
+
from typing import Protocol
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
class IResource(Protocol):
|
|
6
|
+
"""Structural mirror of Resource's public surface."""
|
|
7
|
+
|
|
8
|
+
def acquire(self) -> None: ...
|
|
9
|
+
def release(self) -> None: ...
|
|
10
|
+
def is_open(self) -> bool: ...
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"""Base resource contract."""
|
|
2
|
+
from abc import ABC, abstractmethod
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
class Resource(ABC):
|
|
6
|
+
"""Anything with an acquire/release lifecycle."""
|
|
7
|
+
|
|
8
|
+
@abstractmethod
|
|
9
|
+
def acquire(self) -> None: ...
|
|
10
|
+
|
|
11
|
+
@abstractmethod
|
|
12
|
+
def release(self) -> None: ...
|
|
13
|
+
|
|
14
|
+
def is_open(self) -> bool:
|
|
15
|
+
return False
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
"""Pipeline execution scope."""
|
|
2
|
+
from threading import RLock
|
|
3
|
+
from example.core.resource import Resource
|
|
4
|
+
from example.pipeline.stage import Stage
|
|
5
|
+
from example.storage.store import Store
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
class Pipeline(Resource):
|
|
9
|
+
"""Execution scope that owns its stages and borrows a store."""
|
|
10
|
+
|
|
11
|
+
def __init__(self, store: Store) -> None:
|
|
12
|
+
self._lock = RLock()
|
|
13
|
+
self._stages: list[Stage] = [Stage("load"), Stage("validate")]
|
|
14
|
+
self._store = store
|
|
15
|
+
|
|
16
|
+
def acquire(self) -> None: ...
|
|
17
|
+
def release(self) -> None: ...
|
|
18
|
+
def add_stage(self, stage: Stage) -> None: ...
|
|
19
|
+
def run(self, payload: bytes) -> bytes: ...
|
|
20
|
+
def stage_names(self) -> list[str]: ...
|