Add Docusaurus documentation site and GitHub Pages deployment#2
Merged
ludgerpaehler merged 3 commits intomasterfrom Apr 27, 2026
Merged
Add Docusaurus documentation site and GitHub Pages deployment#2ludgerpaehler merged 3 commits intomasterfrom
ludgerpaehler merged 3 commits intomasterfrom
Conversation
Set up a complete Docusaurus site under docs/ covering the full KoopmanRL surface: introduction, installation, quickstart, all four algorithms (SKVI, SAKC, LQR, SAC baselines), all four environments (LinearSystem, FluidFlow, Lorenz, DoubleWell) with dynamics equations and parameter tables, hyperparameter optimization pipelines, an API reference, and a developer contributing guide. Add two GitHub Actions workflows: deploy-docs.yml deploys the built site to GitHub Pages on every push to master; test-deploy-docs.yml validates the build on pull requests. Both pin Node 20 to avoid a webpack/Node 25 compatibility issue in Docusaurus 3.9.2. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Docusaurus build: - Pin webpack to 5.96.1 via npm overrides to avoid the ProgressPlugin schema breakage introduced in webpack 5.97 - Switch favicon from .ico to .svg and add minimal SVG logo/favicon assets so the static glob copy step has files to process - Remove missing social card image reference from docusaurus.config.ts pre-commit: - Wrap overlong docstring in generate_trajectories.py (E501, 170 > 120) - Apply ruff-format and isort auto-fixes across koopmanrl_utils/movies and tests/test_hparam_opt.py Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…_iteration These two files in the dynamicslab/KoopmanRL master branch were not compliant with ruff-format, causing the pre-commit CI to fail on the PR. Co-Authored-By: Claude Sonnet 4.6 <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
1 participant
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
docs/with KaTeX math renderingdeploy-docs.yml(deploys to GitHub Pages on push tomaster) andtest-deploy-docs.yml(validates build on PRs)Test plan
test-deploy-docs.ymlCI check passes on this PRdeploy-docs.ymldeploys to GitHub Pages and the site is live athttps://dynamicslab.github.io/KoopmanRL/🤖 Generated with Claude Code