Reorganize adapter input and preparation documentation - #1159
Draft
termoshtt wants to merge 7 commits into
Draft
Conversation
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
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
INPUT_CLASSmembership,PreparationPolicy, and the removed-constraint lifecycle, while routing exact formulas, preconditions, generated artifacts, errors, and atomicity to the API referenceMotivation
The previous documentation mixed an obsolete capability model, user-owned model preparation, special-constraint lowering details, and Adapter implementation guidance. This made it difficult for users to tell whether an Adapter would accept an
Instanceexactly, who was responsible for applying a recommended policy, and how transformed constraints remained available for evaluation.The new structure gives each layer one owner: tutorials teach the immediate workflow, user guides explain concepts and responsibility boundaries, the generated API reference defines exact operation contracts, and the Developer Guide points Adapter authors to the shared contracts and reference implementations.
Impact
Users now encounter Preparation only after first solving models that need no transformation, and application-specific choices such as penalty weights remain explicit. Adapter authors get a direct path to
INPUT_CLASS, caller-owned Preparation, removed constraints, and the requirement to encode and decode only used decision variables. Existing published tutorial and capability-model URLs continue to lead readers to the new documentation.