Skip to content

docs: review getting-started and performance pages#374

Merged
ocots merged 1 commit into
mainfrom
docs/review-getting-started
Jul 13, 2026
Merged

docs: review getting-started and performance pages#374
ocots merged 1 commit into
mainfrom
docs/review-getting-started

Conversation

@ocots

@ocots ocots commented Jul 13, 2026

Copy link
Copy Markdown
Member

Summary

This PR improves the documentation with minor fixes and additions:

  • getting-started.md: Added explanatory text in the "Building an initial guess" section. Split the single @repl block into an @example block (for construction) and an @repl block (for querying), so the construction code is hidden from the REPL output.
  • performance.md: Moved the @meta block before the title heading (DocumenterVitepress convention).
  • make.jl: Added a comment explaining how the draft mode works and how to disable it per-file.

- Add explanatory text in getting-started initial guess section
- Split @repl block into @example + @repl for initial guess
- Move @meta block before title in performance.md
- Add draft mode documentation comment in make.jl
@ocots
ocots merged commit 3bea4a7 into main Jul 13, 2026
6 checks passed
@ocots
ocots deleted the docs/review-getting-started branch July 13, 2026 16:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant