docs: add comprehensive mdbook documentation wiki - #6
Merged
alexnodeland merged 4 commits intoFeb 22, 2026
Merged
Conversation
Add a complete documentation wiki using mdbook with the following sections: Getting Started: - Installation guide with feature flags - Core concepts (genomes, fitness, operators, bounds) - Quick start example - First optimization tutorial Tutorials: - Continuous optimization with Sphere function - Multimodal optimization with Rastrigin - CMA-ES for advanced continuous optimization - Island Model for parallel evolution - Genetic programming and symbolic regression - Interactive evolution with human feedback - Hyperparameter learning with Bayesian adaptation How-To Guides: - Choosing the right algorithm - Custom fitness functions - Custom genome types - Custom operators - Checkpointing and recovery - Parallel evolution - Multi-objective optimization - WASM and browser usage Reference: - Algorithms (SimpleGA, CMA-ES, NSGA-II, Island Model, EDA) - Genome types (RealVector, BitString, Permutation, TreeGenome) - Operators (selection, crossover, mutation) - Fitness functions and benchmarks - Termination criteria Architecture: - Design philosophy - Fugue PPL integration - Type system Also enhances rustdoc comments in lib.rs with comprehensive module overview, features list, and examples listing. Examples in documentation link to files in the examples/ directory rather than embedding static code.
- Add docs.yml workflow for automated GitHub Pages deployment - Builds both rustdoc and mdbook documentation - Combines them with rustdoc under /api path - Deploys to GitHub Pages on push to main/master - Update ci.yml to verify mdbook builds on PRs - Add Makefile targets for mdbook documentation: - mdbook: build mdbook docs - mdbook-serve: serve with live reload - mdbook-clean: clean build artifacts - doc-all: build rustdoc + mdbook - doc-serve: build and serve combined docs - Update introduction.md with API reference link
- Update mdbook version from 0.4.40 to 0.4.44 in CI workflows - Add mdbook test step to CI to verify code examples compile - Add Rust toolchain and cargo cache to mdbook CI job - Fix repository URL in book.toml to point to alexnodeland/fugue-evo - Add Makefile targets: - mdbook-test: test code examples in documentation - clean-all: clean both cargo and mdbook artifacts
- Add CNAME file for evo.fugue.run custom domain - Update site-url in book.toml for custom domain - Copy CNAME into build output in docs workflow - Tag all 33 unmarked code blocks across 21 docs files with proper language identifiers (text) so mdbook test doesn't try to compile them as Rust Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
alexnodeland
deleted the
claude/add-documentation-wiki-01DiLkUkuyrJH8Dbxum3D4PD
branch
February 22, 2026 19:43
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
2 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.
Add a complete documentation wiki using mdbook with the following sections:
Getting Started:
Tutorials:
How-To Guides:
Reference:
Architecture:
Also enhances rustdoc comments in lib.rs with comprehensive
module overview, features list, and examples listing.
Examples in documentation link to files in the examples/ directory
rather than embedding static code.