Skip to content

docs: add code map and first evolution tutorial (closes #15, #26)#37

Merged
NeuZhou merged 1 commit intomasterfrom
chore/p1-docs
Apr 13, 2026
Merged

docs: add code map and first evolution tutorial (closes #15, #26)#37
NeuZhou merged 1 commit intomasterfrom
chore/p1-docs

Conversation

@NeuZhou
Copy link
Copy Markdown
Owner

@NeuZhou NeuZhou commented Apr 13, 2026

P1: Documentation Improvements

Changes

  1. Code Map (docs/code-map.md) — Closes Create Code Map document (docs/code-map.md) #26

    • Comprehensive guide to the repository structure for new contributors
    • Covers all 7 core modules with detailed tables
    • ASCII dependency graph showing module relationships
    • Quick-reference "Where to look" table
  2. First Evolution Tutorial (docs/tutorials/first-evolution-run.md) — Closes Add example notebook: Your First Evolution Run #15

    • Step-by-step guide: install → demo mode → quick mode → full mode
    • Explains output format, DNA structure, generation files
    • Advanced options: Pareto, validation, reproducibility
    • Troubleshooting section
  3. Codecov badge — Already present in README.md (HTML format), no change needed

- Codecov badge already present in README.md (no change needed)
- Add docs/code-map.md: comprehensive project structure guide for
  new contributors, covering all core modules and dependency graph
  (closes #26)
- Add docs/tutorials/first-evolution-run.md: step-by-step tutorial
  for running first evolution with demo/quick/full modes (closes #15)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 13, 2026

Welcome to Codecov 🎉

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

ℹ️ You can also turn on project coverage checks and project coverage reporting on Pull Request comment

Thanks for integrating Codecov - We've got you covered ☂️

@NeuZhou NeuZhou merged commit 4cedb91 into master Apr 13, 2026
4 checks passed
@NeuZhou NeuZhou deleted the chore/p1-docs branch April 13, 2026 07:48
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.

Create Code Map document (docs/code-map.md) Add example notebook: Your First Evolution Run

1 participant