Readme packaging for pckg artifacts
Platform spec ADR
Readme packaging for pckg artifacts
Spec standingStandard
- Contracts and edge cases Normative guarantees and known edge cases for `Corelib discovery and packaging`.
- Design model Conceptual model for `Corelib discovery and packaging` and its subsystem boundaries.
- Examples Practical examples that demonstrate `Corelib discovery and packaging` behavior.
- FAQ and troubleshooting Common questions and debugging guidance for `Corelib discovery and packaging`.
- Flow and algorithm End-to-end control flow for corelib discovery, materialization, and packaging.
- Verification and traceability How `Corelib discovery and packaging` requirements map to tests and implementation anchors.
0 revisions (git unavailable at build; counts may be empty)
No commits recorded for this path.
| Section id | Required | Found |
|---|---|---|
what-this-feature-specifies | yes | yes |
implementation-anchors | yes | yes |
Full tree: run pnpm verify:platform-spec-layout (writes src/generated/platform-spec-layout-report.json).
Context
Section titled “Context”Registry consumers expect root README.md in .bpk artifacts.
Decision
Section titled “Decision”| Rule | Detail |
|---|---|
| Declare | Optional readme = "path.md" in Project.proj |
| Default | readme.md at package root when present |
| Pack | beskid pckg pack places resolved file as README.md |
Consequences
Section titled “Consequences”pckg documentation ingest uses consistent entry filename.
Verification anchors
Section titled “Verification anchors”PackagePublishDocumentation.cs; pack integration tests.