docs.md
Documentation
How to use Cherenkov, read its editorials and visualizations, and contribute to the project.
Start here
Reading and using the site
- Reading an editorialThe anatomy of a Cherenkov editorial (hook, problem, idea, interactive, proof) and how to use principles and error types.
- Using the visualizationsHow the interactive visualizations work: playback controls, sliders, keyboard and touch use, and the kinds of visualization you will meet.
- The study plannerHow accounts and the OSN study planner work: choosing a stage, rating your topics, confirming with quizzes and following the plan.
Contributing
- Writing an editorialHow to add an editorial or a material: file locations, frontmatter fields, MDX and math, and where the visualization goes.
- Editing with KeystaticUsing the in-browser content editor: what it can edit, who can reach it, and how its saves become commits.
- The scene builderBuild interactive visualizations without writing code: composed scenes from shapes and sliders, or programmable scenes from blocks.
- Contributing and reporting problemsHow to report a bug or content error, suggest an improvement, or contribute code and writing to Project Cherenkov.