Documentation improvements: fix typo, broken reference, and add missing example#325
Merged
ChrisRackauckas merged 1 commit intoSciML:mainfrom Jan 9, 2026
Conversation
…ng example - Fixed typo in indexing_behavior.md: "origianl" -> "original" - Removed broken @contents reference to non-existent "examples/example1.md" in index.md - Added missing coulomb_control.md example to make.jl pages list All examples in docs/src/examples/ are now properly listed in the documentation build. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <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
3 participants
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
This PR fixes several documentation issues:
indexing_behavior.md:94: Changed "origianl" to "original"index.md: The@contentsdirective referenced a non-existent fileexamples/example1.mdmake.jl: Thecoulomb_control.mdexample exists indocs/src/examples/but was not listed in the documentation build configurationChanges
docs/src/indexing_behavior.md: Fixed spelling errordocs/src/index.md: Removed broken@contentsdirective that referenced non-existent example filedocs/make.jl: Addedexamples/coulomb_control.mdto the pages list so it appears in the built documentationAll changes have been verified by rebuilding the documentation locally with no errors or warnings.
Test Plan
julia --project make.jl- no errors or warningsdocs/src/examples/are now properly listed inmake.jlcc @ChrisRackauckas
🤖 Generated with Claude Code