Skip to content

Migrates docs tooling to zensical and improves API navigation#6

Merged
MitchellAcoustics merged 12 commits intodevfrom
zensical-migration
Mar 27, 2026
Merged

Migrates docs tooling to zensical and improves API navigation#6
MitchellAcoustics merged 12 commits intodevfrom
zensical-migration

Conversation

@MitchellAcoustics
Copy link
Copy Markdown
Owner

Why

  • Improves documentation consistency across local and CI builds by standardizing on a single, modern site configuration.
  • Reduces contributor setup friction by defining shared editor Python environment defaults.
  • Makes API reference pages easier to scan and navigate with richer metadata and cleaner rendering behavior.

What it improves

  • Adds centralized docs generation settings for navigation, theme behavior, social links, and math rendering defaults.
  • Replaces deprecated legacy docs configuration to avoid drift and maintenance overhead.
  • Adds page-level visual metadata and normalizes reference directive formatting for more predictable output.
  • Introduces site branding polish with a favicon.
  • Pins and updates documentation-related dependencies and lock data so builds stay reproducible.

Andrew Mitchell added 6 commits March 27, 2026 01:58
Introduces a dedicated documentation configuration and
pins the required tooling so local and CI builds stay in
sync.

Improves navigation, theming, social links, and rendering
defaults to make reference docs easier to browse and more
consistent.
Adds per-page icon metadata and normalizes directive
formatting so generated reference pages render consistently
with the new documentation theme.

Improves scanability in navigation and reduces formatting
noise that can cause uneven output.
Sets a shared workspace interpreter management default so
contributors get predictable local setup behavior in the
editor.

Reduces onboarding friction and avoids per-user drift in
development configuration.
@MitchellAcoustics MitchellAcoustics self-assigned this Mar 27, 2026
@MitchellAcoustics MitchellAcoustics added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 27, 2026
@MitchellAcoustics MitchellAcoustics merged commit 230018c into dev Mar 27, 2026
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant