Contributing and reporting problems

Project Cherenkov is built in the open and licensed under the MIT licence. Every editorial is a git-tracked file, so the history of every change is public.

Reporting a problem

• For a mistake in an editorial, material or the syllabus, open an issue on GitHub or email the project, saying which page and what is wrong.
• For a visualization that misbehaves, include the page address, your browser and device, and what you did just before.
• For an accessibility problem, tell us what you were using (screen reader, keyboard only, zoom, a switch device) and what got in the way. Accessibility reports are treated as bugs.

The project's contact address and repository link are in the site footer and on the About page.

Contributing

• Writing: read Writing an editorial and open a pull request with a new .mdx file.
• Translating: the interface strings live in messages/en.json and messages/id.json. Documentation pages live in content/docs/<locale>/. To translate one, add a file with the same name under content/docs/id/.
• Code: the stack is Next.js, TypeScript and Tailwind. Run pnpm install, then pnpm dev. Run pnpm lint, pnpm typecheck and pnpm test before opening a pull request.

Frequently asked questions

Do I need an account to read editorials?

No. Reading, the syllabus, materials and the visualizations never require an account.

Why does every editorial have a visualization?

The visualization is how the idea is explored. An editorial without a working visualization is treated as a content error and flagged on the page.

Why are principle and error type free text?

The vocabulary is still settling, and tightening it too early would force editorials into categories that do not fit yet.

Where is the developer documentation?

Environment variables, deployment notes and architecture documents are in the docs/ folder of the repository on GitHub. They are not published on the site.