Skip to content

Document the shared package manifest contract - #518

Open
3alpha wants to merge 1 commit into
masterfrom
docs/manifest-contract
Open

3alpha wants to merge 1 commit into
masterfrom
docs/manifest-contract

Conversation

@3alpha

@3alpha 3alpha commented Nov 11, 2026 •

Copy link
Copy Markdown
Member

The manifest reference teaches legacy upstream fields, a string-valued global-env flag and an unsupported UPnP field name. Its mixed-service example also makes service references difficult to follow.

Replace it with a coherent manifest/Compose pair; document upstream[], short global-env names, service-reference checks, upnpDisable, supported update warnings and literal-dot versions. Explain template identity and positional array inheritance in the development guides. Preserve current front matter/navigation and the old UPnP anchor.

Companion changes: SDK validation and Shared schema/runtime. The reference explicitly identifies the shared-schema release needed for legacy global-env objects. Related UPnP documentation proposal: #475.

Validation:

  • Docusaurus production build passes on current master.
  • The complete manifest/Compose example passes the corrected shared schema and SDK spec checks.
  • Markdown/MDX and JSON/YAML examples were checked together with the companion guide.
  • Base npm ci fails because optional platform packages are missing from the existing lockfile. The build used npm install --ignore-scripts --lockfile-version=2 in an isolated worktree, with the lockfile restored before commit. Existing unrelated broken-anchor warnings remain.

@3alpha
3alpha requested a review from a team as a code owner November 11, 2026 11:04
@3alpha 3alpha added the bug Something isn't working label Nov 11, 2026
@netlify

netlify Bot commented Nov 11, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for steady-daffodil-d78dee ready!

Name Link
🔨 Latest commit 459c1d5
🔍 Latest deploy log https://app.netlify.com/projects/steady-daffodil-d78dee/deploys/6af44bafed0eaa64b7d059a0
😎 Deploy Preview https://deploy-preview-518--steady-daffodil-d78dee.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions

Copy link
Copy Markdown

This branch was successfully deployed

1 active deployment
pull request — 459c1d50 Deployed Nov 11, 2026 by github-actions[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant