docs: Sync maintainer docs with current code - #1313
Merged
Merged
Conversation
Reviewed docs/maintainers against the codebase and fixed drift: - DslGenerators: correct package name to @contract-case/definition-generator - CodingStandards: replace stale .eslintrc-style example with the flat eslint.config.mjs form and correct package name (@contract-case/eslint-config-case-maintainer) - PackageStructure: document the case-definition-generator package, and replace the truncated case-definition-dsl note - it is being deprecated in favour of the definition generator - AddingDsl: clarify the standalone @contract-case/case-boundary package was removed; boundary types now live inside case-connector Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Keep AddingDsl referencing only current/future states. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
Reviewed
docs/maintainers/against the current codebase and fixed places where the docs no longer match the code.DslGenerators.md@contract-case/definition-generator(was@contract-case/case-definition-generator)CodingStandards.md.eslintrc-styleextendsexample with the actual flat-config form (eslint.config.mjsimporting@contract-case/eslint-config-case-maintainer)PackageStructure.mdcase-definition-generatorpackage; replaced the truncatedcase-definition-dslsentence with its real status — it is being deprecated in favour of the definition generatorAddingDsl.md@contract-case/case-boundarypackage was removed; boundary types now live insidecase-connectorVerification
Each change was checked against the source:
@contract-case/definition-generatorconfirmed inpackages/case-definition-generator/package.jsonpackages/case-core/eslint.config.mjsand the package name inpackages/eslint-config-case-maintainer/package.jsoncase-definition-dslconfirmed to depend on / re-export both the http and function plugin DSLs@contract-case/case-boundarypackage or source references remain🤖 Generated with Claude Code