Circles user documentation¶
These are the docs for people who use Circles. Anything about building,
deploying or testing it lives in docs/dev.
Who each section is for¶
| Section | Audience | Scope |
|---|---|---|
circle/ |
Anyone in a circle | Being in a room: joining, seeing, speaking, reacting |
host/ |
Hosts | Creating and running rooms |
admin/ |
Site admins | People, scenes, branding, usage |
The one rule for writing these¶
Every capability is described exactly once. Its home is wherever it is performed or configured, not wherever it is felt:
- A host is also a participant, so everything in
circle/already applies to them and is never restated inhost/. - An admin who hosts a circle reads
host/for that, not a second copy insideadmin/.
Where a topic spans sections, link to the single description instead of
repeating it. host/running-a-round.md covers starting and stopping a round;
what a round feels like to take part in is circle/rounds.md, linked, not
copied.
If you find yourself explaining something twice, one of the two is in the wrong place.
Contents¶
circle/ — for everyone in a circle¶
- Joining a circle — the link, the entry screen, choosing devices, and the cameras-on rule
- What you are looking at — the circles, the centre, the scene, and when people appear
- Speaking and the centre — taking the centre, the talking stick, the three layouts
- Sound and camera — muting, the temporary unmute window, losing your camera
- Rounds — taking part in a round
- Reactions — the heart
- When something goes wrong — connection trouble, frozen video, getting back in
host/ — for hosts¶
- Hosting basics — what a host is, host mode, the room menu
- Creating a room — the room settings
- Choosing a scene — picking, searching, filtering
- Personalising a room — room-specific media
- Inviting people — the join URL and room keys
- Running a round — starting, timing, aborting
- Ending a circle — The End, and the goodbye URL
- Your host profile — name, photo, host logo
admin/ — for site admins¶
- Admin overview — the admin area and what is admin-only
- People and access — users, invites, roles
- Scene library — what a scene is, creating and editing one
- Scene categories — grouping the library
- Rooms administration — every room, across every host
- Branding and settings — logos, colours, welcome copy
- Usage and reports — overview, rooms, hosts, reports, sync health