docs: audit and update all guides#371
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
Comprehensive documentation audit and update for CTModels.jl.
New guide
docs/src/model/display.md: Documents theCTModels.Displaymodule —Base.showextensions forModelandPreModel, mathematical rendering, abstract definitions, and theRecipesBase.plotstub.Audited guides (16 files updated)
Model guides:
model/overview.md: Added Display guide to reading order table.model/types_and_traits.md: AddedConstraintsModelto the noun-family table; addedis_initial_time_fixed/is_initial_time_free/is_final_time_fixed/is_final_time_freepredicate accessors.model/components.md: Addedinitial_timeaccessor mention; added "Symbolic definitions" section coveringDefinition,EmptyDefinition, andexpression.model/constraints.md: Added raw constraint accessors (path_constraints_nl,boundary_constraints_nl,state/control/variable_constraints_box); addedisempty_constraintsandconstraintreferences.model/building.md: Addedhas_abstract_definition,is_abstractly_defined,isempty_constraintsto the accessor example; documentedget_build_examodel.Solution guides:
solution/overview.md: Addedis_empty,is_empty_time_grid,has_duals,modelto the anatomy table.solution/time_grids.md: Added "Checking for emptiness" section withis_emptyandis_empty_time_grid.solution/duals.md: Addedboundary_constraints_dualaccessor; added box-constraint dual accessors table (lb/ub for state/control/variable); addeddim_dual_*accessors; addedhas_duals/EmptyDualModelsection; addedmodelaccessor.solution/trajectories.md: No changes needed (already complete).Initial guess guides:
initial_guess/overview.md: AddedAbstractInitialGuess/AbstractPreInitialGuesstype hierarchy mention.initial_guess/formats.md: Added "Per-component constructors" section documentinginitial_state,initial_control,initial_variable.initial_guess/validation.md: No changes needed (already complete).Serialization guides:
serialization/overview.md: No changes needed (already complete).serialization/export_import.md: Improved low-level tags note with proper@reflinks toJLD2Tag,JSON3Tag,AbstractTag.serialization/plotting.md: No changes needed (already complete).Navigation updates
docs/make.jl: Added"Displaying Models" => "model/display.md"to the OCP Model section.docs/src/index.md: Added Display guide to the developer guides list.docs/src/getting-started.md: Added Display guide row to the Next Steps table.Build verification
julia --project=docs docs/make.jlbuilds cleanly with no cross-reference warnings.