All docs

Collect and review feedbackGuide
Feedback tells you how the community experiences your services. This guide shows you how to receive feedback, review it, and decide what needs to happen next.
Community OS User DocumentationReference
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.
Confirm registrations and check-insGuide
Registrations tell you who plans to come. This guide shows you how to confirm RSVPs, manage the waitlist, and record check-ins so you know who is at the event. You can also record accessibility requests so the event is welcoming for everyone.
Create and distribute a surveyGuide
A survey collects structured answers from a group of people. This guide shows you how to create a survey, add questions, publish it, and review the responses.
Manage an advocacy caseGuide
An advocacy case supports a person who needs help with an issue, such as a complaint or a decision that affects them. This guide shows you how to open a case, keep it up to date, and record how it was resolved.
Manage people in the communityGuide
The community CRM is the central record of every person in your community. This guide shows you how to create a person record, keep it accurate, and add notes over time. A good record makes it easy to find someone, understand their needs, and coordinate support.
Match volunteers with opportunitiesGuide
The volunteer hub matches people who want to help with roles that need filling. This guide shows you how to keep volunteer profiles current, publish opportunities, and review the best matches.
Plan and measure a campaignGuide
A campaign reaches out to the community for a goal, such as more event sign-ups or more members. This guide shows you how to plan a campaign, record its details, and measure its results.
Publish a community storyGuide
Stories share the experiences of community members. This guide shows you how to record a story, add photos or audio with consent, and publish it so others can read it.
Publish and manage eventsGuide
Events bring the community together. This guide shows you how to publish an event so people can see it and register. You will create the event, add the details, publish it, and keep it accurate while people sign up.
Run a community consultationGuide
A consultation asks the community what it thinks about an issue before a decision is made. This guide shows you how to run a consultation from start to finish: publish the question, collect responses, group the answers into themes, and share the outcome.
Send notifications and broadcastsGuide
Messaging keeps the community informed. This guide shows you how to send a notification to one person, send a broadcast to a group, and help people control the messages they receive.
Track a referralGuide
A referral connects a person with the services they need. This guide shows you how to record a referral, choose a provider, update its status, and record the outcome so nothing is left hanging.
Track event attendanceGuide
Attendance records show who came to an event. This guide shows you how to build an attendance record for an event, count who arrived, and record who did not show up. Accurate attendance helps you plan better events and report on how many people the community reached.
Use the community directoryGuide
The community directory helps you find people, organizations, and support workers. This guide shows you how to search the directory, narrow results, and open a record to get the details you need.
Use the provider portalGuide
The provider portal is the space where a service organization connects with the community. This guide shows you how to set up a portal, add published events and shared resources, and manage the provider's permissions.
View reports on the communityGuide
Reports show how the community is doing. This guide shows you how to open each report, understand what it measures, and use the numbers to make decisions.
View trust connections and ambassadorsGuide
The community graph maps how people are connected. This guide shows you how to view relationships and trust connections between people, and how to review ambassador activity so you can strengthen the community's reach.
What are the shared foundation types?Concept
The common foundation is not an app. It is the shared layer that every other domain builds on. It provides the base types that other records reuse, such as people, organizations, events, and addresses. It also provides the codelists that keep data consistent, such as languages, regions, and accessibility preferences.
What are the reports?Concept
The reports are summaries of community activity and wellbeing. Each report covers a period and records when it was generated.
What is a campaign?Concept
A campaign is a planned outreach effort. It has a name, the channels it uses, start and end dates, a target audience, and a budget.
What is a consultation?Concept
A consultation is a formal way to ask the community what it thinks about a topic. It has a title, a sponsoring organisation, a closing date, and one or more questions.
What is a referral?Concept
A referral connects a person with a service provider. The referral records who is being referred, who made the referral, what the person needs, and which provider was recommended.
What is a story?Concept
A story is a community member's account of their experience. Each story records the person, a title, and the content of what they shared. Stories can include media, such as a photo, audio, a video, or text.
What is a survey?Concept
A survey is a set of structured questions sent to a group of people. Each survey has a title and a list of questions. Questions can be short answer, multiple choice, or rating.
What is advocacy?Concept
Advocacy is support for a person who needs help with an issue. It might be a complaint, a decision that affects them, or a service that has not worked. An advocacy case is the record of that support.
What is an attendance record?Concept
An attendance record is a summary of who actually came to an event. It is different from an RSVP, which only says who planned to come.
What is an event?Concept
An event is a scheduled gathering for the community. It can be in person or online. Each event has a title, a description, a date and time, and a location or online link.
What is an RSVP?Concept
An RSVP is a person's reply to an event invitation. It tells the organisers whether the person plans to attend. An RSVP can be Confirmed, Pending, or Cancelled.
What is feedback?Concept
Feedback is a record of what a community member thinks about a service, an event, or the community itself. A feedback submission can be made with a name or anonymously.
What is messaging?Concept
Messaging is how the community sends and receives messages. It has three kinds of records:
What is the community CRM?Concept
The community CRM is the shared contact record for your community. It stores one record per person. Each record holds the person's name, contact methods, accessibility preferences, tags, and a history of notes.
What is the community graph?Concept
The community graph maps the connections between people in the community. It keeps three kinds of records:
What is the directory?Concept
The community directory is a searchable list of the people, organizations, and support workers in the community. Each entry points to a person or an organization and carries categories, searchable keywords, and a region.
What is the provider portal?Concept
The provider portal is the space where a service organization connects with the community. Each portal links an organization to the events it publishes and the resources it shares.
What is the volunteer hub?Concept
The volunteer hub connects people who want to volunteer with opportunities that need help. It keeps three kinds of records:
What is Community OSGuide
Community OS is the online home of a trust network. A trust network is a group of people who work together so one person can get the support they need. The person at the centre is called the beneficiary. Everyone else in the network acts only with the beneficiary's permission.
Create your identityGuide
Your identity in Community OS is a permanent digital address called a DID. Short for Decentralized Identifier. Think of it as your address on the trust network. You create it once, and you keep it for life. It never changes.
Sign inGuide
Signing in to Community OS uses a magic link. A magic link is a sign-in link sent to your email address. You select the link, and Community OS opens with you signed in. There is no password to remember.
What is a Personal Data Server (PDS)Technical
A Personal Data Server (PDS) is the online service that stores and serves one person's records. It holds the person's repository and answers requests for the records in it. In Community OS, the records that name a person, such as their support plan, delegations, and consent grants, live in that person's own PDS repository.
How DID resolution worksTechnical
A DID is a permanent digital address. DID resolution is the process that turns that address into the current details of the person, organisation, or service behind it. When a record names someone by their DID, the system resolves the DID to find where that person's records live and how to reach them.
How delegated authority is representedTechnical
Authority in the trust network is represented as data, not as a fixed list of roles. Three kinds of record describe who may act for whom, over which records, and until when. The system reads these records at every access decision.
Community OS Documentation StandardReference
This standard is the single reference for every user-facing document in Community OS. It defines the three doc types, the guide template, the plain-language rules, the accessibility rules, and the frontmatter schema. Follow it for every new document and every edit to an existing one.
GlossaryReference
This glossary defines the controlled vocabulary used across the Community OS user documentation. Every definition is in plain language. The style guide sets the rules for using these terms.
Roles in the trust networkReference
This reference lists the roles in the trust network, what each role can do, and who holds the role in practice. Use it to decide who needs which role, and what that person can do with records.
Permissions in Community OSReference
This reference explains the permission vocabulary. A permission names what one thing an account can do with one kind of record. Use it to understand why an account can or cannot take an action.
Record statuses in the trust networkReference
This reference lists the record statuses in the trust network. A status tells you whether a record is in effect now. Use it to check why a record grants or denies access.
Become a trusteeGuide
A beneficiary chooses the people they trust. When Wiremu chooses Hana to act for him, Hana becomes a trustee. A trustee acts for the beneficiary within set limits, called a scope. The scope names the records the trustee may work with, such as the support plan.
Accept an invitationGuide
A beneficiary who wants you to act for them sends you an invitation. The invitation names you as a delegate on a delegation record. Accepting the invitation makes you a trustee. You are not required to accept. You decide.
Delegate authorityGuide
Delegating authority means giving a trustee the power to act for you on a scope of records. A scope names the records, such as your support plan. You choose the trustee, the scope, and the dates. You keep control. A delegation alone does not let the trustee see anything. Your consent is always needed too.
Grant consentGuide
Consent is your permission for someone or an app to access a collection of your records. A collection is a set of records, such as your support plan. You choose who gets access and at what level. Read means they can view. Write means they can view and change.
Set up a support arrangementGuide
A support arrangement is the record that assigns a support worker to a beneficiary for a set period. It names the beneficiary, the support worker, the organization, and the role. It has a start date, an end date, and a status.
Access a support planGuide
A support plan is the beneficiary's record of their goals, preferences, services, and appointments. Examples of preferences are accessibility needs such as braille. Examples of services are personal care.
Review and revoke consentGuide
Consent is your permission for someone or an app to access a collection of your records. You can review your consent grants at any time. You can revoke one to stop access. Revoking consent stops access immediately.
Resign as a trusteeGuide
As a trustee you act for a beneficiary within set limits. You are not forced to keep the role. You can resign at any time. Resigning means ending your delegation. After you resign, the delegation is revoked and you lose access to the beneficiary's records.
What is a trusteeConcept
A trustee is a person a beneficiary trusts to act for them within set limits. The beneficiary chooses their trustees. A trustee is not an employee and not a stranger. A trustee is someone the beneficiary knows and relies on.
What is delegated authorityConcept
Delegated authority is the power a beneficiary gives a trustee to act for them. The beneficiary decides the limits. The trustee acts only within those limits.
What is consentConcept
Consent is a beneficiary's permission for someone or an app to access a collection of their records. It is the beneficiary's choice, recorded in a consent grant. It is never assumed and never implied.
What is a support arrangementConcept
A support arrangement is the record that assigns a support worker to a beneficiary for a set period. It makes the working relationship formal and time-bound.
What is a DIDConcept
A DID is a Decentralized Identifier. It is the permanent digital address of a person, an organization, or a service in Community OS. Every record that names someone uses a DID.