docs: align user guides with Diátaxis - #114
Merged
Merged
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
The top-level categories already resembled Diátaxis, but several pages mixed tutorials, operational procedures, conceptual discussion, API contracts, and benchmark interpretation. This change keeps the existing technical content while giving each page one primary reader need.
While executing the revised examples, I confirmed that variopt 0.2.0 cannot deserialize a loky request-local success carrying
CandidateRefinement. The worker guide now uses the threading backend and states that limitation instead of presenting an unreliable path. Ordinary loky objective evaluation is unaffected.Verification
pre-commit run --all-filesuv run --extra docs mkdocs build --strictuv run pytest(1710 passed)