Website
The Quollix website is the canonical documentation hub for the Quollix ecosystem. It follows a text-first approach, as text is searchable and easy to maintain.
Contribution scope
Please contribute text changes only. Avoid custom HTML, CSS, and JavaScript. Use Markdown for simplicity. Structural changes, layout changes, animations, and media changes such as adding or editing images must be discussed first and, if accepted, are handled by the Quollix maintainer.
Useful text contributions include:
- adding missing factual information
- correcting outdated or inaccurate information
- removing unnecessary or misplaced content
- making wording clearer and leaner
- reducing duplicated content by linking to existing pages instead of repeating the same information
Writing guidelines
When writing website content:
- keep the content lean
- use concise, factual language
- keep articles clearly scoped. When helpful, state the scope in the first sentence, for example “This article explains…”
- use sentence case for titles and headings, for example “Editing users” instead of “Editing Users”
- use lowercase for generic feature names in running text, for example backup server,
[backup server](...) - keep proper names such as Quollix, App Store, Quollix Store Client, OIDC, and Docker Compose capitalized
- write with an honest, neutral tone. The website should build trust through accurate information, not read like advertising.
- avoid marketing language, exaggeration, vague claims, and polished-sounding promises that are not directly supported by facts
- present limitations, tradeoffs, and current project status clearly when they are relevant
Terminology
When writing content for the website, follow the Terminology article for Quollix-specific terms and preferred wording. Link terms to this article when it helps readers understand a term that is not already explained by the surrounding context.