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. Structural changes, layout changes, and media changes such as adding or editing images must be discussed first and, if accepted, are handled by a 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
- 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
Use the preferred terms below so the same concept is described with the same wording throughout the site.
| Term | Description | Avoid |
|---|---|---|
| Authorization code flow | Browser-based OIDC sign-in flow where an app uses OIDC client credentials to authenticate with an OIDC provider. | |
| OIDC client | Application or service that lets users sign in through an OIDC provider. | Client, app, service when the OIDC role should be clear |
| OIDC client credentials | Client ID and client secret used by an OIDC client during sign-in. | |
| OIDC provider | Service that authenticates users for OIDC sign-in. Quollix can also act as an OIDC provider. | Identity provider, authentication provider, auth provider |
| Quollix server | Server that runs Quollix. | Quollix instance, node |
| Server | Physical or virtual machine that runs software or accepts network connections. | Node |
| Sign-in | User authentication action. | Login, log in |