Skip to content

Commit 7fde91c

Browse files
alukachclaude
andcommitted
docs: name the manage pages after their commands, with invitations on their own page
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
1 parent 262487b commit 7fde91c

2 files changed

Lines changed: 10 additions & 8 deletions

File tree

‎AGENTS.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ Record with `docs/recorder/`: `docs/recorder/README.md` says how to write a demo
140140

141141
A PR that changes `README.md` or `docs/` gets a preview of the docs site at `https://cli.source.coop/pr-preview/pr-N/`, where N is the PR's number. The *Docs* workflow builds it and comments the link on the PR, and the preview is removed when the PR closes. PRs from forks get a build check only.
142142

143-
- **Call out the docs changes** in the description: say what changed and link each changed page on the preview, such as `…/pr-preview/pr-N/managing-products/#create`. A page is its `##` section's anchor; an anchor inside it follows `#`.
143+
- **Call out the docs changes** in the description: say what changed and link each changed page on the preview, such as `…/pr-preview/pr-N/products/#create`. A page is its `##` section's anchor; an anchor inside it follows `#`.
144144
- **Look at the preview before asking for review.** A broken link, a demo that doesn't load, or a page split wrongly by a new `##` heading is a bug in the PR.
145145

146146
### The stub server

‎README.md‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ aws s3 ls s3://my-org/my-data --profile source-coop
4141

4242
- **Get started:** [Install](#install), [Signing in](#signing-in)
4343
- **Get data:** [Reading data with AWS tools](#reading-data-with-aws-tools)
44-
- **Manage source.coop:** [Products](#managing-products), [Members](#managing-members), [Service accounts](#managing-service-accounts), [Service account sign-ins](#service-account-sign-ins)
44+
- **Manage source.coop:** [Products](#products), [Members](#members), [Invitations](#invitations), [Service accounts](#service-accounts)
4545
- **How commands work:** [Prompts](#prompts), [Browsing with `-i`](#browsing-with--i), [Shell completion](#shell-completion)
4646
- **Automate:** [Scripts and AI agents](#scripts-and-ai-agents), [Any API request](#any-api-request)
4747
- **Reference:** [Configuration](#configuration), [Credential storage](#credential-storage)
@@ -274,7 +274,7 @@ endpoint_url = https://data.source.coop
274274

275275
<!-- group: Manage source.coop -->
276276

277-
## Managing products
277+
## Products
278278

279279
`source-coop product` lists, views, creates, edits and deletes products through the source.coop API (`/api/v1`). The CLI does not check values itself. It shows the API's errors for each field. A product's name is `ACCOUNT/PRODUCT`.
280280

@@ -414,9 +414,9 @@ Without a terminal, `delete` needs `--yes`.
414414

415415
![`product delete`: the name typed wrong, then right, then `--yes`](docs/demos/product-delete.svg)
416416

417-
## Managing members
417+
## Members
418418

419-
`source-coop member` manages the members of an organization (`ACCOUNT`) or a product (`ACCOUNT/PRODUCT`). `source-coop invitation` answers the invitations that you receive. A member's name is their account ID. You cannot invite by email.
419+
`source-coop member` manages the members of an organization (`ACCOUNT`) or a product (`ACCOUNT/PRODUCT`). [`source-coop invitation`](#invitations) answers the invitations that you receive. A member's name is their account ID. You cannot invite by email.
420420

421421
**Roles**, from most to least access: `owners`, `maintainers`, `write_data`, `read_data`.
422422

@@ -520,7 +520,9 @@ Without a terminal, `revoke` and `leave` need `--yes`.
520520

521521
![`member revoke` an invitation, then `member leave` with the name typed wrong](docs/demos/member-revoke.svg)
522522

523-
### Your invitations
523+
## Invitations
524+
525+
`source-coop invitation` answers the invitations that you receive. To invite someone, see [Members](#members).
524526

525527
```bash
526528
# invitations that wait for your answer
@@ -543,7 +545,7 @@ When you accept, you become a member with the role of the invitation. With `--js
543545

544546
![`invitation list -i`: accept one, then reject another](docs/demos/invitations.svg)
545547

546-
## Managing service accounts
548+
## Service accounts
547549

548550
A service account is an account for software, such as a GitHub Actions workflow or a script with an API key. It has an owner: you, or an organization that you own or maintain. source.coop must first let that account own service accounts.
549551

@@ -661,7 +663,7 @@ With no flags, `edit` opens a full-screen form with **Name**, then the products
661663

662664
![`service-account edit --access`, then the edit form: take a product away, grant another](docs/demos/service-account-access.svg)
663665

664-
## Service account sign-ins
666+
### Sign-ins
665667

666668
A service account signs in in one of two ways:
667669

0 commit comments

Comments
 (0)