docs: align documentation, examples and snippets with Concerto v4#134
Merged
Conversation
- Replace removed Concerto class with ModelManager.getSerializer()/getType() in validation example - Remove unused Concerto import from all JS API examples - Change addModel() to addCTOModel() for consistency with the canonical API - Update model-maps.md: Maps are enabled by default in v4 (no ENABLE_MAP_TYPE env var needed) - Update model-imports.md: import aliasing enabled by default; strict=true is now the v4 default - Update CLI reference: --strict now defaults to true for compile and generate commands - Update quick-start.md: Node.js requirement is 22+ - Bump @accordproject/concerto-cto to ^4.0.0, @types/node to 22.x, engines.node to >=22.0.0 - Update .nvmrc to Node.js 22 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: Matt Roberts <code@rbrts.uk>
✅ Deploy Preview for concerto-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
The strict option was fully removed from ModelManager in v4 (not just defaulted to true). Strict mode is now mandatory and cannot be disabled. - model-imports.md: replace the "you can pass strict:false" paragraph with a clear note that unversioned namespaces and wildcard imports are no longer supported at all in v4, with a migration callout for users coming from v3 - ref-concerto-cli.md: remove --strict flag from compile and generate command docs — the flag was dropped from the v4 CLI alongside the ModelManager option Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: Matt Roberts <code@rbrts.uk>
Two issues were causing the build to fail: - syncpack enforces exact pinned versions; ^4.0.0 was rejected (SemverRangeMismatch). Pin @accordproject/concerto-cto to 4.1.0 and @types/node to 22.19.19. - CI workflow was still running Node 20; bump matrix and setup-node to Node 22 to match the updated engines.node requirement. Also regenerates package-lock.json against the new dependency versions. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: Matt Roberts <code@rbrts.uk>
On Node 22 this step crashes with MODULE_NOT_FOUND: promise-retry because npm tries to replace itself mid-execution. Node 22 ships with npm 10 which is already recent enough; the global reinstall is unnecessary. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: Matt Roberts <code@rbrts.uk>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Aligns all documentation content, code examples, and configuration with the Concerto v4 breaking changes documented in the 3.0 → 4.0 migration guide.
Concertoclass — replaced withModelManager.getSerializer()+mm.getType()in the validation example; removed from unused imports in all other API examplesaddModel()→addCTOModel()— vocabulary and decorator-command-set examples now use the canonical API namemodel-maps.mdno longer instructs readers to setENABLE_MAP_TYPE=truemodel-imports.mdnote updated accordinglymodel-imports.mdsection rewritten;--strictflag shown as[default: true]in CLI reference forcompileandgenerate.nvmrcandengines.nodebumped@accordproject/concerto-cto— bumped from3.26.0to^4.0.0;@types/nodeupdated to22.xTest plan
npm run buildpasses (Docusaurus build)@accordproject/concerto-core@^4.0.0🤖 Generated with Claude Code