FAQ and troubleshooting

Platform spec article

FAQ and troubleshooting

Back to Project manifest contract ◎ Open feature in platform map

Spec standingStandard

Owner

Piotr Mikstacki pmikstacki@cybernomad.it

Submitter

Piotr Mikstacki pmikstacki@cybernomad.it

Current document

ADRs (2)

1. 0001-hub-authority Hub authority Accepted

   Hub authority

   Context

   Consumers need one contract.

   Decision

   Hub owns Project.proj normative text.

   Consequences

   Mod/Template on hub.

   Verification anchors

   manifest tests.

   Open full ADR page

2. 0002-mod-and-template-project-types Mod and Template types Accepted

   Mod and Template types

   Context

   Discriminate project kinds.

   Decision

   May declare type Mod or Template; hosts use Host + corelib.

   Consequences

   Links to mods/scaffolding.

   Verification anchors

   project fixtures.

   Open full ADR page

Articles

• Contracts and edge cases Strict guarantees and failure modes for Mod project manifests. article Standard Reviewed Wed May 20
• Design model Conceptual model for `Project manifest contract` and its subsystem boundaries. article Standard
• Examples Concrete examples for `Project manifest contract` decisions and usage patterns. article Standard Reviewed Wed May 20
• FAQ and troubleshooting Project manifest tooling FAQ. article Standard
• Flow and algorithm Manifest validation and Mod package discovery flow. article Standard Reviewed Wed May 20
• Project link libraries Normative project.link block for Extern library resolution at link time (v0.3). article Standard Reviewed Wed May 20
• Verification and traceability Verification for tooling-side project manifest contracts. article Standard

History

0 revisions (git unavailable at build; counts may be empty)

Open full history on GitHub

No commits recorded for this path.

Completeness

OKfeature · 5 SpecSection(s) · 0 H2 heading(s)

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).

Related spec docs

• Feature
  Project manifest contract

  Parent feature hub

• Feature
  Project link libraries

  FFI link metadata

Unknown project.type

Only Host (omitted), Mod, and Template are valid. Typos fail structural parse with stable diagnostics (E1801–E1899 band — see compiler manifest feature).

Mod contracts in a host project

Move compiler-mod code to a type: Mod dependency package. Hosts consume mods through the graph, not inline contract definitions.

maxGeneratorRounds ignored

Ensure mod { } is nested under project, not a top-level block. Unknown mod keys error at parse time.

Readme missing on pckg after pack

Set readme = "docs/README.md" or add root readme.md. beskid pckg pack maps the resolved file to zip root README.md.

Template shortName mismatch

Align project.template.shortName with .beskid/template.json when both are present.

Full key reference

See Project manifest contract (compiler) and the manifests area hub—avoid duplicating tables in tooling articles.