Contributing

EVERJUST is built on open source and ships its own apps on top. If you're extending the platform or improving these docs, here's how to keep it clean.

Code

• Match the surrounding code. Naming, structure, and comment density should read like the file you're editing.
• Keep apps in the addons path and license them compatibly with the core (LGPL-3).
• Test before you ship. Run the test suite and the branding check.
• Branding. This is a debranded platform. User-facing text says EVERJUST, never the name of the upstream framework. The branding check fails the build on leaks.

These docs

The documentation is plain Markdown, served by the control plane at everjust.app/docs. Source files live in control-plane/docs_content/; the sidebar, ordering, search, and on-page contents are derived automatically from that tree, so you only write the pages.

cd control-plane
python3 -m uvicorn main:app --reload   # preview at http://127.0.0.1:8000/docs
python3 -m pytest tests/test_app.py -q  # check the docs still render + link up

To add a page: drop a .md file under docs_content/ and add its slug to SECTIONS in docs_content.py so it shows up in the sidebar.

Write in the EVERJUST voice: plain words, concrete outcomes, second person, no buzzwords. Mirror the page anatomy of the existing app guides — intro, what you can do, configuration, related links.

Voice

• Plain words, real things. Short declarative sentences.
• Confidence without hype. No "seamless," "robust," "unlock."
• Specific beats vague. Numbers and outcomes over adjectives.
• Talk to one person ("you").
• A little dry, never cute. No emoji.