DocsGetting started
Community OS User Documentation
A map of the Community OS user documentation and how to add a document.
This folder holds the user-facing documentation for Community OS. It is written for the people who use the trust network: beneficiaries, trustees, support workers, coordinators, and family members.
Structure
| Folder | What it holds |
|---|---|
getting-started/ | Guides for new users: what Community OS is, creating your identity, signing in. |
trust-network/ | Guides for the trust network tasks: becoming a trustee, delegating authority, granting consent, support arrangements, support plans. |
concepts/ | Plain-language explanations of the ideas behind the system: trustee, delegation, consent, support arrangement, DID. |
reference/ | Lookup material: the glossary, roles, permissions, and statuses. |
technical/ | Brief plain-language explainers of the underlying technology, linking to the repo docs/ files. |
_template/ | Templates to copy when you add a guide, concept, or reference. |
_style-guide.md | The writing standard for every document in this folder. |
The documents
Getting started
- What is Community OS
- Create your identity
- Sign in
Trust network
- Become a trustee
- Accept an invitation
- Delegate authority
- Grant consent
- Set up a support arrangement
- Access a support plan
- Review and revoke consent
- Resign as a trustee
Concepts
- What is a trustee
- What is delegated authority
- What is consent
- What is a support arrangement
- What is a DID
Reference
- Glossary
- Roles in the trust network
- Permissions in Community OS
- Record statuses in the trust network
Technical
- What is a Personal Data Server (PDS)
- How DID resolution works
- How delegated authority is represented
How to add a document
Read the Community OS Documentation Standard first. It sets the doc types, the guide template, the plain-language rules, the accessibility rules, and the frontmatter.
- Choose the doc type: guide, concept, reference, or technical.
- Copy the matching template from
_template/. - Write the content. Follow the plain-language and accessibility rules in the standard.
- Complete the frontmatter. The keys and their order are set in the standard.
- Check the
slugis unique across the folder. - If you add a guide, keep the eight sections in the standard's order.
- Check your document for banned phrases: no "click here", no "above", no "below", no "left", no "right", no "see the diagram".
How this documentation is published
The documents in this folder are synced into EmDash, the admin and documentation site, by the infrastructure. The sync runs automatically. You do not need to publish anything by hand. Keep the frontmatter valid, because the sync uses the slug, title, order, and docType keys to build the navigation.