Skip to content

Redesign the documentation experience for v1.9.2 - #12

Merged
ikelaiah merged 1 commit into
mainfrom
docs/v1.9.2-documentation-experience
Aug 22, 2026
Merged

Redesign the documentation experience for v1.9.2#12
ikelaiah merged 1 commit into
mainfrom
docs/v1.9.2-documentation-experience

Conversation

@ikelaiah

Copy link
Copy Markdown
Owner

Summary

Redesigns StringKit-FP's generated documentation into a polished, version-aware developer documentation site inspired by mathlib-fp's documentation architecture.

Navigation

  • Hierarchical sidebar
  • Breadcrumbs
  • On-page table of contents
  • Previous/next navigation

Reading experience

  • Responsive layout
  • Dark/light themes
  • Improved typography
  • Enhanced Pascal code blocks
  • Tables and callouts

Discovery

  • Documentation homepage
  • Version selector
  • Dependency-free client-side search

Builder

  • Improved dependency-free static site generator
  • Stronger built-site validation
  • Version-safe, offline-safe assets

Testing

  • Python docs builder: 6 tests
  • Built-site checker: 4 tests
  • Source checker: 2 tests
  • Documentation examples: 14 compiled and run
  • Complete site: 32 pages across v1.9.1 and v1.9.2
  • Library: 159 tests, 0 failures
  • Lazarus package build: passed

Compatibility

No intentional breaking API changes.

@ikelaiah
ikelaiah marked this pull request as ready for review August 22, 2026 10:43
@ikelaiah
ikelaiah merged commit 330413a into main Aug 22, 2026
2 checks passed
@ikelaiah
ikelaiah deleted the docs/v1.9.2-documentation-experience branch August 22, 2026 10:49
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