@c4a/context-cli 0.6.18 → 0.7.0
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.
- package/README.md +73 -8
- package/README.zh-CN.md +47 -7
- package/cli.js +89881 -53821
- package/docs/document-optimization.md +35 -11
- package/docs/document-optimization.zh-CN.md +29 -9
- package/indexers/bundles/context-code-indexer/SKILL.md +20 -0
- package/indexers/bundles/context-code-indexer/context-indexer.yaml +230 -0
- package/indexers/bundles/context-code-indexer/references/composers/contracts-and-chains.md +23 -0
- package/indexers/bundles/context-code-indexer/references/composers/cross-module-chain.md +22 -0
- package/indexers/bundles/context-code-indexer/references/composers/development-and-delivery.md +22 -0
- package/indexers/bundles/context-code-indexer/references/composers/event-flow.md +21 -0
- package/indexers/bundles/context-code-indexer/references/composers/examples-and-documentation.md +22 -0
- package/indexers/bundles/context-code-indexer/references/composers/persistence-boundary.md +21 -0
- package/indexers/bundles/context-code-indexer/references/composers/protocol-boundary.md +22 -0
- package/indexers/bundles/context-code-indexer/references/composers/public-contract.md +23 -0
- package/indexers/bundles/context-code-indexer/references/indexer.md +49 -0
- package/indexers/bundles/context-code-indexer/references/metrics.md +201 -0
- package/indexers/bundles/context-code-indexer/templates/adapter-integration.md +119 -0
- package/indexers/bundles/context-code-indexer/templates/api-service.md +118 -0
- package/indexers/bundles/context-code-indexer/templates/background-runtime.md +109 -0
- package/indexers/bundles/context-code-indexer/templates/cli-tool.md +129 -0
- package/indexers/bundles/context-code-indexer/templates/component-library.md +99 -0
- package/indexers/bundles/context-code-indexer/templates/contract-source.md +73 -0
- package/indexers/bundles/context-code-indexer/templates/data-sync-reconciliation.md +77 -0
- package/indexers/bundles/context-code-indexer/templates/derived-generated-source.md +117 -0
- package/indexers/bundles/context-code-indexer/templates/domain-service.md +109 -0
- package/indexers/bundles/context-code-indexer/templates/event-consumer.md +62 -0
- package/indexers/bundles/context-code-indexer/templates/gateway-facade.md +89 -0
- package/indexers/bundles/context-code-indexer/templates/monorepo-container.md +124 -0
- package/indexers/bundles/context-code-indexer/templates/plugin-extension.md +52 -0
- package/indexers/bundles/context-code-indexer/templates/sdk-library.md +132 -0
- package/indexers/bundles/context-code-indexer/templates/storage-repository.md +56 -0
- package/indexers/bundles/context-code-indexer/templates/web-application.md +146 -0
- package/indexers/bundles/context-code-indexer/tests/fixtures/chapters.json +226 -0
- package/indexers/bundles/context-code-indexer/tests/fixtures/composers.json +82 -0
- package/indexers/bundles/context-code-indexer/tests/fixtures/profiles.json +210 -0
- package/indexers/bundles/context-code-indexer/tests/fixtures/scenarios.json +122 -0
- package/indexers/bundles/context-markdown-indexer/SKILL.md +20 -0
- package/indexers/bundles/context-markdown-indexer/context-indexer.yaml +147 -0
- package/indexers/bundles/context-markdown-indexer/references/classification.md +63 -0
- package/indexers/bundles/context-markdown-indexer/references/editorial-policy.md +106 -0
- package/indexers/bundles/context-markdown-indexer/references/indexer.md +23 -0
- package/indexers/bundles/context-markdown-indexer/references/semantic-planning.md +146 -0
- package/indexers/bundles/context-markdown-indexer/references/structure-and-artifacts.md +109 -0
- package/indexers/bundles/context-markdown-indexer/tests/fixtures/anonymous.json +31 -0
- package/indexers/bundles/context-markdown-indexer/tests/fixtures/editorial.json +309 -0
- package/indexers/bundles/context-markdown-indexer/tests/fixtures/migration-equivalence.json +186 -0
- package/indexers/bundles/context-markdown-indexer/tests/fixtures/profiles.json +171 -0
- package/indexers/bundles/context-markdown-indexer/tests/fixtures/routing.json +151 -0
- package/indexers/capability-manifest.json +40 -0
- package/indexers/contracts/hard-rule-conformance.json +2644 -0
- package/indexers/contracts/operator-contract.json +35 -0
- package/indexers/contracts/profile-contract.json +10162 -0
- package/indexers/release-manifest.json +208 -0
- package/package.json +5 -4
- package/plugins/README.md +17 -109
- package/plugins/README_CN.md +11 -89
- package/plugins/VERSION +1 -1
- package/plugins/claude/.claude-plugin/plugin.json +3 -11
- package/plugins/claude/CLAUDE.md +1 -1
- package/plugins/claude/README.md +1 -1
- package/plugins/claude/commands/context.md +112 -7
- package/plugins/codex/.codex-plugin/plugin.json +6 -17
- package/plugins/codex/AGENTS.md +1 -1
- package/plugins/codex/README.md +1 -1
- package/plugins/codex/skills/context/SKILL.md +113 -19
- package/plugins/cursor/.cursor-plugin/plugin.json +4 -17
- package/plugins/cursor/AGENTS.md +1 -1
- package/plugins/cursor/README.md +3 -2
- package/plugins/cursor/commands/c4a-context.md +112 -9
- package/plugins/skills/{c4a-context → context}/SKILL.md +114 -20
- package/plugins/skills/context-code-indexer/SKILL.md +20 -0
- package/plugins/skills/context-code-indexer/context-indexer.yaml +230 -0
- package/plugins/skills/context-code-indexer/references/composers/contracts-and-chains.md +23 -0
- package/plugins/skills/context-code-indexer/references/composers/cross-module-chain.md +22 -0
- package/plugins/skills/context-code-indexer/references/composers/development-and-delivery.md +22 -0
- package/plugins/skills/context-code-indexer/references/composers/event-flow.md +21 -0
- package/plugins/skills/context-code-indexer/references/composers/examples-and-documentation.md +22 -0
- package/plugins/skills/context-code-indexer/references/composers/persistence-boundary.md +21 -0
- package/plugins/skills/context-code-indexer/references/composers/protocol-boundary.md +22 -0
- package/plugins/skills/context-code-indexer/references/composers/public-contract.md +23 -0
- package/plugins/skills/context-code-indexer/references/indexer.md +49 -0
- package/plugins/skills/context-code-indexer/references/metrics.md +201 -0
- package/plugins/skills/context-code-indexer/templates/adapter-integration.md +119 -0
- package/plugins/skills/context-code-indexer/templates/api-service.md +118 -0
- package/plugins/skills/context-code-indexer/templates/background-runtime.md +109 -0
- package/plugins/skills/context-code-indexer/templates/cli-tool.md +129 -0
- package/plugins/skills/context-code-indexer/templates/component-library.md +99 -0
- package/plugins/skills/context-code-indexer/templates/contract-source.md +73 -0
- package/plugins/skills/context-code-indexer/templates/data-sync-reconciliation.md +77 -0
- package/plugins/skills/context-code-indexer/templates/derived-generated-source.md +117 -0
- package/plugins/skills/context-code-indexer/templates/domain-service.md +109 -0
- package/plugins/skills/context-code-indexer/templates/event-consumer.md +62 -0
- package/plugins/skills/context-code-indexer/templates/gateway-facade.md +89 -0
- package/plugins/skills/context-code-indexer/templates/monorepo-container.md +124 -0
- package/plugins/skills/context-code-indexer/templates/plugin-extension.md +52 -0
- package/plugins/skills/context-code-indexer/templates/sdk-library.md +132 -0
- package/plugins/skills/context-code-indexer/templates/storage-repository.md +56 -0
- package/plugins/skills/context-code-indexer/templates/web-application.md +146 -0
- package/plugins/skills/context-code-indexer/tests/fixtures/chapters.json +226 -0
- package/plugins/skills/context-code-indexer/tests/fixtures/composers.json +82 -0
- package/plugins/skills/context-code-indexer/tests/fixtures/profiles.json +210 -0
- package/plugins/skills/context-code-indexer/tests/fixtures/scenarios.json +122 -0
- package/plugins/skills/context-markdown-indexer/SKILL.md +20 -0
- package/plugins/skills/context-markdown-indexer/context-indexer.yaml +147 -0
- package/plugins/skills/context-markdown-indexer/references/classification.md +63 -0
- package/plugins/skills/context-markdown-indexer/references/editorial-policy.md +106 -0
- package/plugins/skills/context-markdown-indexer/references/indexer.md +23 -0
- package/plugins/skills/context-markdown-indexer/references/semantic-planning.md +146 -0
- package/plugins/skills/context-markdown-indexer/references/structure-and-artifacts.md +109 -0
- package/plugins/skills/context-markdown-indexer/tests/fixtures/anonymous.json +31 -0
- package/plugins/skills/context-markdown-indexer/tests/fixtures/editorial.json +309 -0
- package/plugins/skills/context-markdown-indexer/tests/fixtures/migration-equivalence.json +186 -0
- package/plugins/skills/context-markdown-indexer/tests/fixtures/profiles.json +171 -0
- package/plugins/skills/context-markdown-indexer/tests/fixtures/routing.json +151 -0
- package/providers/context/actions/accept-main-index-run.yaml +7 -0
- package/providers/context/actions/accept-material-answer-run.yaml +7 -0
- package/providers/context/actions/accept-post-author-composer-run.yaml +7 -0
- package/providers/context/actions/actualize-material-answer-bindings.yaml +8 -0
- package/providers/context/actions/apply-code-index-guidance.yaml +5 -0
- package/providers/context/actions/apply-document-optimization-guidance.yaml +5 -0
- package/providers/context/actions/apply-indexer-project.yaml +7 -0
- package/providers/context/actions/audit-material-gap-state.yaml +8 -0
- package/providers/context/actions/audit-projected-artifact-fan-out.yaml +8 -0
- package/providers/context/actions/authorize-indexer-contract-overlay.yaml +7 -0
- package/providers/context/actions/authorize-indexer-dependencies.yaml +7 -0
- package/providers/context/actions/authorize-indexer-program-execution.yaml +7 -0
- package/providers/context/actions/build-main-index-author-worksets.yaml +7 -0
- package/providers/context/actions/build-main-index-catalog-fallback.yaml +7 -0
- package/providers/context/actions/build-main-index-partition-worksets.yaml +7 -0
- package/providers/context/actions/build-material-question-workset.yaml +7 -0
- package/providers/context/actions/build-post-author-composer-worksets.yaml +7 -0
- package/providers/context/actions/build-question-target-inventory.yaml +7 -0
- package/providers/context/actions/build-subject-catalog.yaml +7 -0
- package/providers/context/actions/build-target-resolution-views.yaml +7 -0
- package/providers/context/actions/checkpoint-material-answer-review.yaml +8 -0
- package/providers/context/actions/checkpoint-material-gaps.yaml +8 -0
- package/providers/context/actions/close-indexer-approved-knowledge.yaml +8 -0
- package/providers/context/actions/compile-indexer-candidates.yaml +8 -0
- package/providers/context/actions/compose-indexer-post-author-fragments.yaml +7 -0
- package/providers/context/actions/configure-community-indexer-fallback.yaml +6 -0
- package/providers/context/actions/configure-indexer-providers.yaml +6 -0
- package/providers/context/actions/confirm-index-requirement-workset.yaml +8 -0
- package/providers/context/actions/confirm-subject-reidentification.yaml +8 -0
- package/providers/context/actions/converge-main-index-partition-run.yaml +7 -0
- package/providers/context/actions/discover-markdown-indexer-providers.yaml +6 -0
- package/providers/context/actions/evaluate-material-gaps.yaml +8 -0
- package/providers/context/actions/fail-main-index-run.yaml +7 -0
- package/providers/context/actions/fail-material-answer-run.yaml +7 -0
- package/providers/context/actions/fail-post-author-composer-run.yaml +7 -0
- package/providers/context/actions/inspect-index-candidate-review-readiness.yaml +8 -0
- package/providers/context/actions/inspect-index-profile-failure.yaml +7 -0
- package/providers/context/actions/inspect-indexer-dependencies.yaml +7 -0
- package/providers/context/actions/inspect-indexer-program-execution.yaml +7 -0
- package/providers/context/actions/inspect-indexer-project-proposal.yaml +7 -0
- package/providers/context/actions/inspect-markdown-provider-capture.yaml +7 -0
- package/providers/context/actions/inspect-material-answer-review.yaml +8 -0
- package/providers/context/actions/maintain-evidence.yaml +1 -1
- package/providers/context/actions/materialize-indexer-instructions.yaml +7 -0
- package/providers/context/actions/migrate-codeindex.yaml +5 -0
- package/providers/context/actions/observe-indexer-project.yaml +7 -0
- package/providers/context/actions/observe-main-index-run-ledger.yaml +7 -0
- package/providers/context/actions/observe-material-answer-runs.yaml +7 -0
- package/providers/context/actions/observe-post-author-composer-worksets.yaml +7 -0
- package/providers/context/actions/override-index-profile-audit.yaml +7 -0
- package/providers/context/actions/prepare-indexer-customization-project.yaml +7 -0
- package/providers/context/actions/prepare-main-index-run-ledger.yaml +7 -0
- package/providers/context/actions/prepare-material-answer-runs.yaml +7 -0
- package/providers/context/actions/propose-indexer-customization.yaml +7 -0
- package/providers/context/actions/propose-overlay-question-amendment.yaml +7 -0
- package/providers/context/actions/rebind-indexer-selection-to-requirement.yaml +7 -0
- package/providers/context/actions/reconcile-indexer-results.yaml +7 -0
- package/providers/context/actions/record-index-profile-revision.yaml +7 -0
- package/providers/context/actions/register-source-batch.yaml +1 -1
- package/providers/context/actions/report-index-profile-failure.yaml +7 -0
- package/providers/context/actions/report-indexer-incremental-impact.yaml +8 -0
- package/providers/context/actions/resolve-effective-composers.yaml +7 -0
- package/providers/context/actions/restore-repository-sources.yaml +1 -1
- package/providers/context/actions/review-material-answer-candidate.yaml +8 -0
- package/providers/context/actions/revise-index-output.yaml +7 -0
- package/providers/context/actions/route-index-requirement-confirmation.yaml +8 -0
- package/providers/context/actions/route-indexer-provider-selection.yaml +7 -0
- package/providers/context/actions/run-indexer-agent-step.yaml +7 -0
- package/providers/context/actions/run-indexer-post-author-composer.yaml +7 -0
- package/providers/context/actions/run-material-answer-indexers.yaml +7 -0
- package/providers/context/actions/start-main-index-run.yaml +7 -0
- package/providers/context/actions/start-material-answer-run.yaml +7 -0
- package/providers/context/actions/start-post-author-composer-run.yaml +7 -0
- package/providers/context/actions/validate-indexer-contract-overlays.yaml +7 -0
- package/providers/context/actions/validate-indexer-customization.yaml +7 -0
- package/providers/context/actions/validate-indexer-selection-proposal.yaml +7 -0
- package/providers/context/actions/validate-main-index-run.yaml +7 -0
- package/providers/context/actions/validate-markdown-provider-selection.yaml +7 -0
- package/providers/context/actions/validate-subject-key-schemas.yaml +8 -0
- package/providers/context/codes.yaml +72 -0
- package/providers/context/graphs/indexer.yaml +1068 -0
- package/providers/context/graphs/workspace.yaml +52 -3
- package/providers/context/manifest.json +1487 -157
- package/providers/context/provider.yaml +3 -2
- package/providers/context/resources/dialogue/code-extraction.md +12 -0
- package/providers/context/resources/dialogue/document-classification.md +1 -1
- package/providers/context/resources/dialogue/knowledge-review.md +7 -1
- package/providers/context/resources/dialogue/source-boundary.md +9 -1
- package/providers/context/resources/dialogue/workflow-mode-after-capture.md +11 -8
- package/providers/context/resources/dialogue/workflow-mode-after-creation.md +6 -4
- package/providers/context/resources/manuals/guides/lark-resources.md +7 -0
- package/providers/context/resources/manuals/guides/package-outputs.md +3 -3
- package/providers/context/resources/manuals/reference/code-extractors.md +7 -6
- package/providers/context/resources/manuals/reference/package-templates.md +18 -10
- package/providers/context/resources/manuals/reference/project-api.md +49 -24
- package/providers/context/resources/procedures/close-and-build.md +24 -9
- package/providers/context/resources/procedures/code-extraction.md +41 -13
- package/providers/context/resources/procedures/code-index-audit.md +83 -13
- package/providers/context/resources/procedures/document-capture.md +9 -0
- package/providers/context/resources/procedures/document-optimization.md +88 -21
- package/providers/context/resources/procedures/document-revision.md +11 -6
- package/providers/context/resources/procedures/knowledge-review.md +4 -1
- package/providers/context/resources/procedures/source-boundary.md +20 -8
- package/providers/context/resources/semantic/align/structure-planning.md +4 -4
- package/providers/context/resources/semantic/code-index/classification.md +8 -5
- package/providers/context/resources/semantic/code-index/templates/adapter.md +9 -0
- package/providers/context/resources/semantic/code-index/templates/contracts-and-chains.md +81 -0
- package/providers/context/resources/views/resolved-indexer-instructions.yaml +23 -0
- package/providers/context/schemas/document-optimization-decisions.schema.json +29 -6
- package/providers/context/schemas/indexer-agent-step-input.schema.json +30 -0
- package/providers/context/schemas/indexer-agent-step-result.schema.json +47 -0
- package/providers/context/schemas/indexer-candidate-compile-input.schema.json +57 -0
- package/providers/context/schemas/indexer-candidate-compile-output.schema.json +38 -0
- package/providers/context/schemas/indexer-candidate-review-readiness-input.schema.json +46 -0
- package/providers/context/schemas/indexer-candidate-review-readiness-output.schema.json +104 -0
- package/providers/context/schemas/indexer-contract-overlay-authorization-input.schema.json +32 -0
- package/providers/context/schemas/indexer-contract-overlay-authorization-result.schema.json +121 -0
- package/providers/context/schemas/indexer-contract-overlay-validation-input.schema.json +90 -0
- package/providers/context/schemas/indexer-contract-overlay-validation-result.schema.json +158 -0
- package/providers/context/schemas/indexer-customization-project-preparation-result.schema.json +44 -0
- package/providers/context/schemas/indexer-customization-proposal-draft.schema.json +83 -0
- package/providers/context/schemas/indexer-customization-validation-result.schema.json +36 -0
- package/providers/context/schemas/indexer-dependency-authorization-input.schema.json +71 -0
- package/providers/context/schemas/indexer-dependency-authorization-result.schema.json +138 -0
- package/providers/context/schemas/indexer-incremental-impact-input.schema.json +31 -0
- package/providers/context/schemas/indexer-incremental-impact-output.schema.json +52 -0
- package/providers/context/schemas/indexer-main-lifecycle-input.schema.json +187 -0
- package/providers/context/schemas/indexer-main-lifecycle-output.schema.json +180 -0
- package/providers/context/schemas/indexer-markdown-provider-capture-input.schema.json +17 -0
- package/providers/context/schemas/indexer-markdown-provider-capture-output.schema.json +54 -0
- package/providers/context/schemas/indexer-markdown-provider-validation-input.schema.json +34 -0
- package/providers/context/schemas/indexer-markdown-provider-validation-output.schema.json +75 -0
- package/providers/context/schemas/indexer-material-answer-lifecycle-input.schema.json +90 -0
- package/providers/context/schemas/indexer-material-answer-lifecycle-output.schema.json +80 -0
- package/providers/context/schemas/indexer-material-answer-review-inspection-input.schema.json +32 -0
- package/providers/context/schemas/indexer-material-answer-review-inspection-output.schema.json +32 -0
- package/providers/context/schemas/indexer-material-answer-review-resolution-input.schema.json +19 -0
- package/providers/context/schemas/indexer-material-answer-review-resolution-output.schema.json +87 -0
- package/providers/context/schemas/indexer-material-gap-lifecycle-input.schema.json +86 -0
- package/providers/context/schemas/indexer-material-gap-lifecycle-output.schema.json +19 -0
- package/providers/context/schemas/indexer-materialize-request.schema.json +53 -0
- package/providers/context/schemas/indexer-materialized-resource.schema.json +57 -0
- package/providers/context/schemas/indexer-overlay-question-amendment.schema.json +13 -0
- package/providers/context/schemas/indexer-overlay-question-proposal-input.schema.json +40 -0
- package/providers/context/schemas/indexer-overlay-question-rebind-input.schema.json +35 -0
- package/providers/context/schemas/indexer-overlay-question-rebind-result.schema.json +25 -0
- package/providers/context/schemas/indexer-post-author-fragment-request.schema.json +26 -0
- package/providers/context/schemas/indexer-post-author-fragment-result.schema.json +18 -0
- package/providers/context/schemas/indexer-post-author-lifecycle-input.schema.json +94 -0
- package/providers/context/schemas/indexer-post-author-lifecycle-output.schema.json +72 -0
- package/providers/context/schemas/indexer-profile-failure-inspection-input.schema.json +13 -0
- package/providers/context/schemas/indexer-profile-failure-inspection-result.schema.json +19 -0
- package/providers/context/schemas/indexer-profile-failure-report-input.schema.json +22 -0
- package/providers/context/schemas/indexer-profile-failure-report-result.schema.json +49 -0
- package/providers/context/schemas/indexer-profile-override-decision.schema.json +20 -0
- package/providers/context/schemas/indexer-profile-override-result.schema.json +49 -0
- package/providers/context/schemas/indexer-profile-revision-agent-input.schema.json +18 -0
- package/providers/context/schemas/indexer-profile-revision-record-input.schema.json +31 -0
- package/providers/context/schemas/indexer-profile-revision-record-result.schema.json +45 -0
- package/providers/context/schemas/indexer-program-execution-authorization-input.schema.json +145 -0
- package/providers/context/schemas/indexer-program-execution-authorization-result.schema.json +60 -0
- package/providers/context/schemas/indexer-project-action-result.schema.json +19 -0
- package/providers/context/schemas/indexer-project-gate-input.schema.json +100 -0
- package/providers/context/schemas/indexer-project-observation-input.schema.json +16 -0
- package/providers/context/schemas/indexer-project-observation-result.schema.json +42 -0
- package/providers/context/schemas/indexer-provider-route-input.schema.json +55 -0
- package/providers/context/schemas/indexer-provider-route-report.schema.json +188 -0
- package/providers/context/schemas/indexer-requirement-confirmation-input.schema.json +27 -0
- package/providers/context/schemas/indexer-requirement-confirmation-output.schema.json +24 -0
- package/providers/context/schemas/indexer-result-reconciliation-input.schema.json +59 -0
- package/providers/context/schemas/indexer-result-reconciliation-output.schema.json +43 -0
- package/providers/context/schemas/indexer-selection-proposal-input.schema.json +12 -0
- package/providers/context/schemas/indexer-selection-proposal-validation.schema.json +23 -0
- package/providers/context/schemas/indexer-subject-reidentification-input.schema.json +37 -0
- package/providers/context/schemas/indexer-subject-reidentification-output.schema.json +31 -0
- package/providers/context/schemas/source-batch-input.schema.json +18 -3
- package/providers/context/skills/configure-indexer-providers/SKILL.md +58 -0
- package/providers/context/skills/prepare-indexer-customization-project/SKILL.md +31 -0
- package/providers/context/skills/propose-indexer-customization/SKILL.md +40 -0
- package/providers/context/skills/revise-index-output/SKILL.md +12 -0
- package/providers/context/skills/run-indexer-agent-step/SKILL.md +20 -0
- package/providers/context/skills/run-indexer-post-author-composer/SKILL.md +21 -0
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: context.code-indexer.template.monorepo-container
|
|
3
|
+
kind: procedure
|
|
4
|
+
media-type: text/markdown
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Monorepo and module-container template
|
|
8
|
+
|
|
9
|
+
Use for `monorepo-container`: a workspace whose stable knowledge is the
|
|
10
|
+
registration, ownership, dependency, build, or release topology of multiple
|
|
11
|
+
child modules. Do not treat the physical repository as one application merely
|
|
12
|
+
because it has one Git remote.
|
|
13
|
+
|
|
14
|
+
Use the exact profile and Artifact policy variant supplied by the workset.
|
|
15
|
+
|
|
16
|
+
## Evidence pass
|
|
17
|
+
|
|
18
|
+
Locate:
|
|
19
|
+
|
|
20
|
+
- workspace/package/service manifests and child-module discovery rules;
|
|
21
|
+
- build graph, task orchestration, cache, dependency, and affected-scope logic;
|
|
22
|
+
- ownership, tags, boundaries, layering, or dependency constraints;
|
|
23
|
+
- shared configuration and tooling inherited by child modules;
|
|
24
|
+
- release groups, independent packages, deployment units, and version policy;
|
|
25
|
+
- generated, mirrored, vendored, fixture, example, and legacy subtrees;
|
|
26
|
+
- cross-module registries or contracts that warrant separate chain units.
|
|
27
|
+
|
|
28
|
+
Use declared manifests as the primary inventory. Directory discovery is a
|
|
29
|
+
fallback and must not silently include generated output or dependency caches.
|
|
30
|
+
|
|
31
|
+
## Questions the knowledge must answer
|
|
32
|
+
|
|
33
|
+
1. How are child modules discovered and identified?
|
|
34
|
+
2. Which modules are applications, services, libraries, tools, or derived
|
|
35
|
+
sources, and who owns them?
|
|
36
|
+
3. What dependency and layering rules connect or constrain them?
|
|
37
|
+
4. How do build, test, cache, release, and deployment boundaries work?
|
|
38
|
+
5. Which configuration is inherited globally versus owned by a child module?
|
|
39
|
+
6. Which cross-module flows are important enough to index separately?
|
|
40
|
+
7. Which large or generated subtrees are intentionally excluded?
|
|
41
|
+
|
|
42
|
+
## Suggested knowledge units
|
|
43
|
+
|
|
44
|
+
- **Module registry**: child identity, path, type, owner, manifest, supported
|
|
45
|
+
entry, build/release unit, and lifecycle.
|
|
46
|
+
- **Dependency/topology map**: declared dependency directions, layering rules,
|
|
47
|
+
shared contracts, and source-backed edges.
|
|
48
|
+
- **Build and release map**: task graph, affected-scope behavior, cache,
|
|
49
|
+
artifacts, release groups, and deployment units.
|
|
50
|
+
- **Shared tooling/configuration**: only stable workspace-level behavior that
|
|
51
|
+
materially affects multiple children.
|
|
52
|
+
- **Cross-module chain unit**: independently owned, source-backed flow joining
|
|
53
|
+
several child modules; do not hide it inside the container summary.
|
|
54
|
+
|
|
55
|
+
Every user-visible child application, service, library, or CLI is classified as
|
|
56
|
+
its own index unit before deeper extraction.
|
|
57
|
+
|
|
58
|
+
Each independently visible child package must have one canonical inventory
|
|
59
|
+
identity and one primary partition owner. If source registration intentionally
|
|
60
|
+
remains at repository level, keep the container registry as an aggregate
|
|
61
|
+
logical unit and let Context build child worksets from canonical package facts;
|
|
62
|
+
do not use file filters to simulate package ownership.
|
|
63
|
+
|
|
64
|
+
## Chapter blueprints
|
|
65
|
+
|
|
66
|
+
```markdown
|
|
67
|
+
# <Workspace> module registry
|
|
68
|
+
## Workspace purpose and discovery rules
|
|
69
|
+
## Child module inventory
|
|
70
|
+
## Module types, ownership, and lifecycle
|
|
71
|
+
## Dependency and layering constraints
|
|
72
|
+
## Shared configuration and tooling
|
|
73
|
+
## Build, test, cache, and release topology
|
|
74
|
+
## Generated/mirrored boundaries and exclusions
|
|
75
|
+
## Cross-module knowledge entrypoints
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
One child-module record may use:
|
|
79
|
+
|
|
80
|
+
```markdown
|
|
81
|
+
## <Module>
|
|
82
|
+
- Path and manifest:
|
|
83
|
+
- Primary/additional types and facets:
|
|
84
|
+
- Responsibility and owner:
|
|
85
|
+
- Stable entrypoints:
|
|
86
|
+
- Direct module dependencies:
|
|
87
|
+
- Build/release unit:
|
|
88
|
+
- Lifecycle/source of truth:
|
|
89
|
+
- Deeper index unit:
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
## Granularity and relationships
|
|
93
|
+
|
|
94
|
+
Do not perform a repository-wide symbol scan as the container extraction. The
|
|
95
|
+
container owns topology; child units own reader-facing application/service/API
|
|
96
|
+
knowledge. Aggregate the registry when hundreds of children share the same
|
|
97
|
+
shape, but preserve exact identities and locators.
|
|
98
|
+
|
|
99
|
+
A workspace manifest, package registry, build graph, or release manifest is a
|
|
100
|
+
valid stable `entries` locator even when the container has no executable
|
|
101
|
+
process. Every registry page must retain exact child identities and locators;
|
|
102
|
+
a directory listing is not a module map.
|
|
103
|
+
|
|
104
|
+
Use manifest/build-graph evidence for dependency edges. Imports can supplement
|
|
105
|
+
but should not override declared workspace ownership or package boundaries.
|
|
106
|
+
|
|
107
|
+
## Template composition examples
|
|
108
|
+
|
|
109
|
+
- A workspace containing a Web app, API gateway, CLI, and generated client
|
|
110
|
+
produces one registry plus separately classified child units.
|
|
111
|
+
- A workspace with independent release groups reads the
|
|
112
|
+
`development-and-delivery.md` composer contract; retain the release map at
|
|
113
|
+
the container level and package-specific compatibility in each `sdk-library`
|
|
114
|
+
unit.
|
|
115
|
+
- A cross-module request flow reads `cross-module-chain.md` and receives its
|
|
116
|
+
own output owner when it spans several child units.
|
|
117
|
+
|
|
118
|
+
## Revise or stop when
|
|
119
|
+
|
|
120
|
+
- module discovery relies only on a broad filesystem scan;
|
|
121
|
+
- the plan treats all repository files as one index unit;
|
|
122
|
+
- child ownership or source-of-truth boundaries are ambiguous;
|
|
123
|
+
- generated/cache/vendor directories dominate projected output;
|
|
124
|
+
- dependencies are inferred solely from names without manifest or graph proof.
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: context.code-indexer.template.plugin-extension
|
|
3
|
+
kind: procedure
|
|
4
|
+
media-type: text/markdown
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Plugin and extension boundary template
|
|
8
|
+
|
|
9
|
+
Use for `plugin-extension`. This file owns the complete plugin contract
|
|
10
|
+
blueprint. CLI, SDK, and adapter templates should point here and only add their
|
|
11
|
+
module-specific command, public API, or mapping context.
|
|
12
|
+
|
|
13
|
+
## Evidence pass
|
|
14
|
+
|
|
15
|
+
Locate:
|
|
16
|
+
|
|
17
|
+
- discovery mechanism, manifest, registry, or installation contract;
|
|
18
|
+
- activation, deactivation, update, and removal lifecycle;
|
|
19
|
+
- contribution points, commands, hooks, providers, and host services;
|
|
20
|
+
- configuration, identity, compatibility, permissions, and isolation;
|
|
21
|
+
- failure containment, fallback, diagnostics, and version negotiation;
|
|
22
|
+
- public extension API and maintained examples when consumers implement it.
|
|
23
|
+
|
|
24
|
+
## Questions the knowledge must answer
|
|
25
|
+
|
|
26
|
+
1. How does the host discover, install, and activate an extension?
|
|
27
|
+
2. What may the extension contribute or call?
|
|
28
|
+
3. Which configuration, identity, permission, and compatibility rules apply?
|
|
29
|
+
4. How are failures isolated, surfaced, and recovered?
|
|
30
|
+
|
|
31
|
+
## Chapter blueprint
|
|
32
|
+
|
|
33
|
+
```markdown
|
|
34
|
+
# <Plugin boundary>
|
|
35
|
+
## Host and extension responsibilities
|
|
36
|
+
## Discovery and installation
|
|
37
|
+
## Activation and removal lifecycle
|
|
38
|
+
## Contribution and capability contracts
|
|
39
|
+
## Configuration, permissions, and isolation
|
|
40
|
+
## Compatibility, failure, diagnostics, and recovery
|
|
41
|
+
## Source-backed host-to-extension relationships
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## Granularity and stop conditions
|
|
45
|
+
|
|
46
|
+
Prefer one contract per host/extension model, with compact records for coherent
|
|
47
|
+
contribution families. Do not create separate copies under CLI, adapter, and
|
|
48
|
+
SDK pages. Every page must name concrete manifests, registries, hooks, or
|
|
49
|
+
capability identities and their source locators.
|
|
50
|
+
|
|
51
|
+
Revise or stop when discovery or activation is inferred, permissions and
|
|
52
|
+
isolation would be guessed, or examples describe an unsupported extension API.
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: context.code-indexer.template.sdk-library
|
|
3
|
+
kind: procedure
|
|
4
|
+
media-type: text/markdown
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# SDK and shared library template
|
|
8
|
+
|
|
9
|
+
Use for `sdk-library`: reusable code packages, component libraries, client
|
|
10
|
+
SDKs, public framework extensions, or shared runtimes consumed through a
|
|
11
|
+
deliberately supported interface. A package being imported elsewhere is not
|
|
12
|
+
enough; confirm its supported entry and consumer contract.
|
|
13
|
+
|
|
14
|
+
Use the exact sdk-library or component-library profile and Artifact policy
|
|
15
|
+
variant supplied by the workset.
|
|
16
|
+
|
|
17
|
+
## Evidence pass
|
|
18
|
+
|
|
19
|
+
Locate:
|
|
20
|
+
|
|
21
|
+
- package manifest, exports map, public barrels, binary/native entry, or
|
|
22
|
+
documented import paths;
|
|
23
|
+
- initialization, providers, factories, configuration, and required runtime;
|
|
24
|
+
- public capability families, components, hooks, types, commands, or clients;
|
|
25
|
+
- supported extension/plugin points and lifecycle;
|
|
26
|
+
- compatibility, platform, peer dependency, and version constraints;
|
|
27
|
+
- maintained examples, tests, API comments, and migration/release notes;
|
|
28
|
+
- external protocol schemas and generated declarations or clients;
|
|
29
|
+
- internal implementation, fixtures, demos, and re-export chains that should
|
|
30
|
+
not become independent reader pages.
|
|
31
|
+
|
|
32
|
+
Use public exports plus maintained documentation together. An exported symbol
|
|
33
|
+
can still be incidental; a documented stable import path can remain public even
|
|
34
|
+
when it re-exports another implementation.
|
|
35
|
+
|
|
36
|
+
## Questions the knowledge must answer
|
|
37
|
+
|
|
38
|
+
1. Who should use this package and what capabilities does it promise?
|
|
39
|
+
2. What are the supported import/initialization paths?
|
|
40
|
+
3. How are public APIs grouped into concepts a consumer can navigate?
|
|
41
|
+
4. What configuration, lifecycle, compatibility, and failure rules apply?
|
|
42
|
+
5. Which examples demonstrate supported use rather than test-only behavior?
|
|
43
|
+
6. Which declarations are generated, and where is their authority?
|
|
44
|
+
7. How is the package built, versioned, and released when that is in scope?
|
|
45
|
+
|
|
46
|
+
## Suggested knowledge units
|
|
47
|
+
|
|
48
|
+
- **Library/module map**: purpose, supported entrypoints, capability families,
|
|
49
|
+
runtime/peer requirements, extension points, and navigation.
|
|
50
|
+
- **Getting started or lifecycle**: installation assumptions, initialization,
|
|
51
|
+
configuration, teardown, and minimal supported examples evidenced by source.
|
|
52
|
+
- **Capability-family reference**: a coherent group of APIs/components with
|
|
53
|
+
usage, contracts, constraints, and related types.
|
|
54
|
+
- **Granular API/component reference**: one symbol or component per page only
|
|
55
|
+
when the package intentionally exposes a granular public contract and the
|
|
56
|
+
measured preview remains appropriate.
|
|
57
|
+
- **Compatibility and migration**: supported platforms/versions and evidenced
|
|
58
|
+
breaking or transitional behavior.
|
|
59
|
+
- **Build/release entry**: only module-owned packaging and release behavior.
|
|
60
|
+
|
|
61
|
+
## Chapter blueprints
|
|
62
|
+
|
|
63
|
+
```markdown
|
|
64
|
+
# <Library> module map
|
|
65
|
+
## Purpose and intended consumers
|
|
66
|
+
## Supported entrypoints and initialization
|
|
67
|
+
## Capability families
|
|
68
|
+
## Runtime, peer, and platform requirements
|
|
69
|
+
## Configuration and lifecycle
|
|
70
|
+
## Extension points and external protocols
|
|
71
|
+
## Compatibility, build, and release
|
|
72
|
+
## Examples, evidence, and exclusions
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
For a capability family:
|
|
76
|
+
|
|
77
|
+
```markdown
|
|
78
|
+
# <Capability family>
|
|
79
|
+
## When to use it
|
|
80
|
+
## Supported imports or components
|
|
81
|
+
## Initialization and configuration
|
|
82
|
+
## API/component contracts
|
|
83
|
+
## Lifecycle, errors, and constraints
|
|
84
|
+
## Minimal source-backed examples
|
|
85
|
+
## Related capabilities and authoritative references
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
For a granular reference page:
|
|
89
|
+
|
|
90
|
+
```markdown
|
|
91
|
+
# <Public API or component>
|
|
92
|
+
## Purpose
|
|
93
|
+
## Import and signature/props
|
|
94
|
+
## Required context and configuration
|
|
95
|
+
## Behavior, lifecycle, and errors
|
|
96
|
+
## Supported example
|
|
97
|
+
## Compatibility and source evidence
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
## Granularity and relationships
|
|
101
|
+
|
|
102
|
+
Prefer capability families over one page per export. A symbol page is justified
|
|
103
|
+
when consumers search for that exact public identity and its contract contains
|
|
104
|
+
meaningful behavior beyond a signature. Do not copy complete function bodies,
|
|
105
|
+
private members, generated declarations, fixtures, or every re-export.
|
|
106
|
+
|
|
107
|
+
When a granular public surface would create enumeration-heavy output, keep the
|
|
108
|
+
public identities navigable but aggregate them into capability-family
|
|
109
|
+
Artifacts. Do not split one source into overlapping owners or invent ordinal
|
|
110
|
+
batches to evade the CLI profile contract.
|
|
111
|
+
|
|
112
|
+
Relate public entries to capability families, configuration, examples, and
|
|
113
|
+
external protocols. Internal call graphs are secondary unless the knowledge
|
|
114
|
+
goal explicitly concerns extension or lifecycle behavior.
|
|
115
|
+
|
|
116
|
+
## Template composition examples
|
|
117
|
+
|
|
118
|
+
- A component library may use granular component pages plus family indexes,
|
|
119
|
+
while its demo site is a separate `web-application` unit.
|
|
120
|
+
- A generated client reads `derived-generated-source.md` and
|
|
121
|
+
`protocol-boundary.md`; document the supported client surface while naming
|
|
122
|
+
the upstream schema authority.
|
|
123
|
+
- A library with a plugin host also reads `adapter-integration.md` and
|
|
124
|
+
`plugin-extension.md`.
|
|
125
|
+
|
|
126
|
+
## Revise or stop when
|
|
127
|
+
|
|
128
|
+
- the public boundary cannot be distinguished from internal exports;
|
|
129
|
+
- examples are invented instead of derived from maintained usage or tests;
|
|
130
|
+
- generated declarations have no identifiable authority;
|
|
131
|
+
- every export or component is selected without a consumer-navigation reason;
|
|
132
|
+
- compatibility or lifecycle claims are unavailable but required by the goal.
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: context.code-indexer.template.storage-repository
|
|
3
|
+
kind: procedure
|
|
4
|
+
media-type: text/markdown
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Storage repository template
|
|
8
|
+
|
|
9
|
+
Use for `storage-repository` when durable state, cache behavior, consistency, or
|
|
10
|
+
recovery is part of the confirmed reader goal. This template supplements the
|
|
11
|
+
service or runtime that owns the operations; it is not a request to catalog
|
|
12
|
+
every model or query.
|
|
13
|
+
|
|
14
|
+
## Evidence pass
|
|
15
|
+
|
|
16
|
+
Locate:
|
|
17
|
+
|
|
18
|
+
- repository/data-access interface and concrete callers;
|
|
19
|
+
- datastore, table, collection, keyspace, entity, or file identity when
|
|
20
|
+
source-backed;
|
|
21
|
+
- transaction, consistency, cache, lock, idempotency, and concurrency bounds;
|
|
22
|
+
- read/write/query families and domain mapping;
|
|
23
|
+
- schema/migration authority, versioning, and operational recovery;
|
|
24
|
+
- generated models, query helpers, fixtures, and migrations that should remain
|
|
25
|
+
supporting evidence.
|
|
26
|
+
|
|
27
|
+
## Questions the knowledge must answer
|
|
28
|
+
|
|
29
|
+
1. Which service or domain operation owns each read or write family?
|
|
30
|
+
2. What durable or cached state is addressed?
|
|
31
|
+
3. Where are transaction, consistency, locking, and idempotency boundaries?
|
|
32
|
+
4. Which schema or migration source is authoritative?
|
|
33
|
+
5. What failure, migration, or recovery behavior is maintained?
|
|
34
|
+
|
|
35
|
+
## Chapter blueprint
|
|
36
|
+
|
|
37
|
+
```markdown
|
|
38
|
+
# <Persistence boundary>
|
|
39
|
+
## Owned state and authoritative schema
|
|
40
|
+
## Repository or data-access entry
|
|
41
|
+
## Callers and operation families
|
|
42
|
+
## Transaction, consistency, cache, and locking behavior
|
|
43
|
+
## Failure, migration, and recovery boundaries
|
|
44
|
+
## Source evidence and excluded query helpers
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## Granularity and stop conditions
|
|
48
|
+
|
|
49
|
+
Group operations by owned state and consistency policy. Split only when schema
|
|
50
|
+
authority, transaction ownership, datastore, or recovery semantics differ.
|
|
51
|
+
Every page must identify real state and caller boundaries with source locators;
|
|
52
|
+
a directory or class inventory is not a persistence model.
|
|
53
|
+
|
|
54
|
+
Revise or stop when the datastore identity or owning operation is unknown,
|
|
55
|
+
transaction/consistency behavior would be guessed, or generated bindings and
|
|
56
|
+
migrations would dominate reader-facing pages.
|
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: context.code-indexer.template.web-application
|
|
3
|
+
kind: procedure
|
|
4
|
+
media-type: text/markdown
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Web and interactive application template
|
|
8
|
+
|
|
9
|
+
Use only after evidence classifies a module as `web-application`. This covers
|
|
10
|
+
browser applications, server-rendered sites, embedded WebViews, desktop Web
|
|
11
|
+
shells, native mobile/desktop applications, cross-platform UI runtimes, and
|
|
12
|
+
similar interactive modules. The `web-application` identifier is retained for
|
|
13
|
+
the current contract but represents an interactive application boundary, not
|
|
14
|
+
only browser code. It does
|
|
15
|
+
not automatically cover every package containing UI components; a reusable
|
|
16
|
+
component package is usually `sdk-library`.
|
|
17
|
+
|
|
18
|
+
Use the exact profile and Artifact policy variant supplied by the workset.
|
|
19
|
+
|
|
20
|
+
## Evidence pass
|
|
21
|
+
|
|
22
|
+
Locate the concrete application bootstrap and trace outward just far enough to
|
|
23
|
+
find:
|
|
24
|
+
|
|
25
|
+
- application mounting, server rendering, shell, or host-container entry;
|
|
26
|
+
- route/page/screen registries and navigation guards;
|
|
27
|
+
- page-to-state, loader, query, client, bridge, or controller boundaries;
|
|
28
|
+
- runtime configuration, environment selection, feature registration, and
|
|
29
|
+
authentication/session initialization;
|
|
30
|
+
- build, local development, test, bundle, and release entrypoints;
|
|
31
|
+
- generated clients, assets, styles, fixtures, and legacy routes that should
|
|
32
|
+
remain evidence rather than reader-facing pages.
|
|
33
|
+
|
|
34
|
+
If the route registry is generated, locate both its generator or source of
|
|
35
|
+
truth and the runtime consumer. Do not infer page identity from a directory
|
|
36
|
+
tree when an explicit registry exists.
|
|
37
|
+
|
|
38
|
+
## Questions the knowledge must answer
|
|
39
|
+
|
|
40
|
+
A useful application index should let a reader determine:
|
|
41
|
+
|
|
42
|
+
1. How does the application start, and which runtime or host does it expect?
|
|
43
|
+
2. What are the stable pages/routes/screens and their entry components?
|
|
44
|
+
3. How does a page obtain data or call an external capability?
|
|
45
|
+
4. Which state, session, bridge, or configuration boundaries affect behavior?
|
|
46
|
+
5. How is the module run, debugged, built, and released?
|
|
47
|
+
6. Which implementation details are intentionally outside the knowledge scope?
|
|
48
|
+
|
|
49
|
+
## Suggested knowledge units
|
|
50
|
+
|
|
51
|
+
Select only units supported by the confirmed goal and evidence:
|
|
52
|
+
|
|
53
|
+
- **Application map**: responsibility, runtime, bootstrap, major subsystems,
|
|
54
|
+
stable dependencies, and navigation to deeper pages.
|
|
55
|
+
- **Route or page registry**: concrete route/page identity, entry component,
|
|
56
|
+
loader/guard, main data boundary, and source locator. Aggregate related
|
|
57
|
+
routes when a page-per-route layout would be repetitive.
|
|
58
|
+
- **Data and protocol boundaries**: add application-specific page, state, and
|
|
59
|
+
session context to the canonical operation record in `protocol-boundary.md`;
|
|
60
|
+
do not create a second operation registry.
|
|
61
|
+
- **State and host integration**: only stable stores, bridges, extension points,
|
|
62
|
+
or host contracts that affect multiple pages or public behavior.
|
|
63
|
+
- **Runtime and delivery guide**: module-owned development commands,
|
|
64
|
+
configuration, build output, deployment/release entry, and evidenced recovery
|
|
65
|
+
paths.
|
|
66
|
+
- **Cross-layer flow**: a source-backed page-to-client-to-provider chain when
|
|
67
|
+
both sides are registered sources.
|
|
68
|
+
|
|
69
|
+
These are possible page families, not a required number of Markdown files.
|
|
70
|
+
|
|
71
|
+
## Chapter blueprints
|
|
72
|
+
|
|
73
|
+
An application-map page may use:
|
|
74
|
+
|
|
75
|
+
```markdown
|
|
76
|
+
# <Application> module map
|
|
77
|
+
## Responsibility and supported runtime
|
|
78
|
+
## Bootstrap sequence
|
|
79
|
+
## Route/page organization
|
|
80
|
+
## State, data, and protocol boundaries
|
|
81
|
+
## Host integrations and extension points
|
|
82
|
+
## Configuration and environment selection
|
|
83
|
+
## Development, build, and release entrypoints
|
|
84
|
+
## Known exclusions and source-of-truth links
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
A route/page registry may use a compact record rather than prose repetition:
|
|
88
|
+
|
|
89
|
+
```markdown
|
|
90
|
+
## <Route or page family>
|
|
91
|
+
- Identity and registration:
|
|
92
|
+
- Entry component or controller:
|
|
93
|
+
- Loader, guard, or initialization:
|
|
94
|
+
- Main client/state dependencies:
|
|
95
|
+
- User-visible outcome:
|
|
96
|
+
- Source evidence:
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
A cross-layer page may use:
|
|
100
|
+
|
|
101
|
+
```markdown
|
|
102
|
+
# <User interaction> execution path
|
|
103
|
+
## Trigger and route entry
|
|
104
|
+
## UI/state orchestration
|
|
105
|
+
## Protocol request and authoritative contract
|
|
106
|
+
## Provider boundary and response handling
|
|
107
|
+
## Failure, fallback, and observability
|
|
108
|
+
## Source-backed relationship chain
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
Do not fill a heading with generic text. Omit or mark a section as a material
|
|
112
|
+
gap when the source cannot support it.
|
|
113
|
+
|
|
114
|
+
## Granularity and relationships
|
|
115
|
+
|
|
116
|
+
Prefer stable application concepts over one page per component, hook, state
|
|
117
|
+
field, style, generated type, or internal helper. A page registry must contain
|
|
118
|
+
real identities and source locators, not just folder names. A protocol page
|
|
119
|
+
must name concrete operations or contract locations, not merely state that the
|
|
120
|
+
application “uses HTTP”.
|
|
121
|
+
|
|
122
|
+
Create structured relationships only when registration, call sites, imports
|
|
123
|
+
with unambiguous ownership, or parser evidence support them. Keep inferred
|
|
124
|
+
product intent out of the index.
|
|
125
|
+
|
|
126
|
+
## Template composition examples
|
|
127
|
+
|
|
128
|
+
- A server-rendered application with local API routes also reads
|
|
129
|
+
`api-service.md` and `protocol-boundary.md`.
|
|
130
|
+
- An embedded application with a host bridge also reads `adapter-integration.md` and the
|
|
131
|
+
applicable `plugin-extension.md` or `protocol-boundary.md` template.
|
|
132
|
+
- A design-system package rendered in a demo application may need separate
|
|
133
|
+
index units: `sdk-library` for the supported package and `web-application`
|
|
134
|
+
for the demo host.
|
|
135
|
+
|
|
136
|
+
## Revise or stop when
|
|
137
|
+
|
|
138
|
+
- no executable bootstrap or route registry can be located;
|
|
139
|
+
- the proposed output is only a directory summary;
|
|
140
|
+
- protocol semantics depend on unavailable material;
|
|
141
|
+
- generated routes or clients are being mistaken for authoritative behavior;
|
|
142
|
+
- one-symbol-per-page selection expands components or API types without a
|
|
143
|
+
deliberate public-reference goal.
|
|
144
|
+
|
|
145
|
+
Resolve these issues before returning the current author Result for mechanical
|
|
146
|
+
audit.
|