Skip to content

[Validation/Docs] Add release checks and docs for shell/profile boundaries #48

@ogyrec-o

Description

@ogyrec-o

Summary

Add release/package validation and documentation that prevents shell/profile boundaries from regressing.

This issue is the guardrail pass after the product-shell packaging split.

Problem

Once Freven supports multiple artifact/product profiles, accidental regressions become likely:

  • host-only artifact accidentally includes Vanilla
  • standalone template accidentally depends on Vanilla
  • Vanilla product forgets required Vanilla payload
  • shell-specific defaults leak into generic host foundation
  • docs tell users to use the wrong artifact

We need checks and docs that make these boundaries visible and enforceable.

Requirements

Add validation/checks for:

  • host-only artifact contains no freven.vanilla payload
  • host-only artifact does not expose Vanilla builtin registry unless explicitly configured
  • Vanilla product artifact includes required Vanilla experience/content
  • standalone custom-game template contains no Vanilla dependency by default
  • DevKit profile manifests identify their profile kind
  • packaging docs match actual artifact contents
  • generic host foundation docs do not describe Vanilla as universal truth

Docs should explain:

  • which artifact/profile to download as a player
  • which artifact/profile to download as a mod author
  • which artifact/profile to use for standalone game development
  • how Vanilla differs from the generic host
  • how experience.stack.toml fits into host/Vanilla/modpack workflows

Non-goals

  • Do not create new shell functionality.
  • Do not redesign packaging again.
  • Do not implement online catalog/search.
  • Do not solve unrelated SDK/rendering/worldgen features.

Deliverables

  • Package inspection checks or CI scripts.
  • Updated release checklist.
  • Updated DevKit docs.
  • Updated product-shell docs.
  • Clear pass/fail examples for each profile.

Metadata

Metadata

Assignees

Labels

area:installInstallation, setup, first-run flows, environment/bootstrap setup.area:mod-loadingMod discovery, resolution, manifests, negotiation, attach/load behavior.area:observabilityLogging, diagnostics, tracing, telemetry, crash/debug visibility.area:runtimeRuntime behavior, lifecycle, ticking, session behavior, execution flow.component:bootfreven-boot: launcher, instance bootstrap, boot flows, packaging entrypoints.component:devkitDevkit-level / cross-repo work: manifests, integration glue, release shell, repo-wide coordination.component:docsDocumentation, guides, READMEs, architecture docs, examples docs.component:enginefreven-engine: core engine/runtime/simulation/client-server internals.component:packagingBuild artifacts, zips, release packaging, manifests, distribution layout.component:vanillafreven-vanilla: built-in gameplay/content/experience implementation.priority:p1High priority. Important and near-term.status:confirmedConfirmed bug/request. Reproduced, accepted, or clearly valid.transport:builtinSpecific to builtin/compile-time mod execution path.transport:cross-transportShared semantic work that must align across builtin/wasm/native/external.

Type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions