Work on documentation

This commit is contained in:
2026-01-31 13:46:43 +01:00
parent 9b730c310e
commit 029b228025
45 changed files with 668 additions and 1318 deletions

View File

@@ -39,62 +39,12 @@ const DOCS: &[DocEntry] = &[
Topic("About Forth", include_str!("../../docs/about_forth.md")),
Topic("The Dictionary", include_str!("../../docs/dictionary.md")),
Topic("The Stack", include_str!("../../docs/stack.md")),
Topic("Arithmetic", include_str!("../../docs/arithmetic.md")),
Topic("Comparison", include_str!("../../docs/comparison.md")),
Topic("Logic", include_str!("../../docs/logic.md")),
// Sound generation
Section("Sounds"),
Topic("Emitting", include_str!("../../docs/emitting.md")),
Topic("Samples", include_str!("../../docs/samples.md")),
Topic("Oscillators", include_str!("../../docs/oscillators.md")),
Topic("Wavetables", include_str!("../../docs/wavetables.md")),
// Sound shaping
Section("Shaping"),
Topic("Envelopes", include_str!("../../docs/envelopes.md")),
Topic(
"Pitch Envelope",
include_str!("../../docs/pitch_envelope.md"),
),
Topic("Filters", include_str!("../../docs/filters.md")),
Topic(
"Ladder Filters",
include_str!("../../docs/ladder_filters.md"),
),
// Movement and modulation
Section("Movement"),
Topic("LFO & Ramps", include_str!("../../docs/lfo.md")),
Topic("Modulation", include_str!("../../docs/modulation.md")),
Topic("Vibrato", include_str!("../../docs/vibrato.md")),
// Effects
Section("Effects"),
Topic("Delay & Reverb", include_str!("../../docs/delay_reverb.md")),
Topic("Mod FX", include_str!("../../docs/mod_fx.md")),
Topic("EQ & Stereo", include_str!("../../docs/eq_stereo.md")),
Topic("Lo-fi", include_str!("../../docs/lofi.md")),
// Variation and randomness
Section("Variation"),
Topic("Randomness", include_str!("../../docs/randomness.md")),
Topic("Probability", include_str!("../../docs/probability.md")),
Topic("Selection", include_str!("../../docs/selection.md")),
// Timing
Section("Timing"),
Topic("Context", include_str!("../../docs/context.md")),
Topic("Cycles", include_str!("../../docs/cycles.md")),
Topic("Timing", include_str!("../../docs/timing.md")),
Topic("Patterns", include_str!("../../docs/patterns.md")),
Topic("Chaining", include_str!("../../docs/chaining.md")),
// Music theory
Section("Music"),
Topic("Notes", include_str!("../../docs/notes.md")),
Topic("Scales", include_str!("../../docs/scales.md")),
Topic("Chords", include_str!("../../docs/chords.md")),
Topic("Generators", include_str!("../../docs/generators.md")),
// Advanced
Section("Advanced"),
Topic("Variables", include_str!("../../docs/variables.md")),
Topic("Conditionals", include_str!("../../docs/conditionals.md")),
Topic("Custom Words", include_str!("../../docs/definitions.md")),
Topic("Ableton Link", include_str!("../../docs/link.md")),
Topic("Creating Words", include_str!("../../docs/definitions.md")),
Topic("Oddities", include_str!("../../docs/oddities.md")),
// Audio Engine
Section("Audio Engine"),
Topic("Introduction", include_str!("../../docs/engine_intro.md")),
Topic("Settings", include_str!("../../docs/engine_settings.md")),
// Reference
Section("Reference"),
Topic("Audio Engine", include_str!("../../docs/audio_engine.md")),