diff --git a/README.md b/README.md index bbf77c3..ec3a5de 100644 --- a/README.md +++ b/README.md @@ -10,13 +10,13 @@ funded through our [Open Collective](https://opencollective.com/inference-cooper ## Start here -- **New here?** → [Getting started](getting-started.md) — join, use the chat, and get involved in governance. +- **New here?** → [Getting started](guides/getting-started.md) — join, use the chat, and get involved in governance. - **Why does this exist?** → [Background](background.md) — a one-page summary of the mission and history. -- **Which models can I use?** → [Models](models.md) — the full catalog of providers and models. -- **Want API access?** → [API access](api-access.md) — use our models programmatically. -- **Want community chat?** → [Getting started · Matrix](getting-started.md) — our federated Matrix server, including how to connect from any client and how to use an existing Matrix account. -- **Curious how it works?** → [Infrastructure](infrastructure.md) — a map of the stack and the codebase. -- **Wondering about the bot?** → [Working with the agent](working-with-the-agent.md) — what the co-op's agents do, who can instruct them, and what always needs a human. +- **Which models can I use?** → [Models](guides/models.md) — the full catalog of providers and models. +- **Want API access?** → [API access](guides/api-access.md) — use our models programmatically. +- **Want community chat?** → [Getting started · Matrix](guides/getting-started.md) — our federated Matrix server, including how to connect from any client and how to use an existing Matrix account. +- **Curious how it works?** → [Infrastructure](operations/infrastructure.md) — a map of the stack and the codebase. +- **Wondering about the bot?** → [Working with the agent](operations/agentic-systems.md) — what the co-op's agents do, who can instruct them, and what always needs a human. - **Need help or have an idea?** → [Support & feature requests](https://git.inference.coop/co-op/support) — open an issue. ## Key links diff --git a/background.md b/background.md index adb005d..b53c2a3 100644 --- a/background.md +++ b/background.md @@ -9,7 +9,7 @@ together. We are a small cooperative by design, fiscally sponsored by the nonprofit [Metagov](https://metagov.org) and managing member dues on [Open Collective](https://opencollective.com/inference-cooperative). -For how to join and use it, see [Getting started](getting-started.md); +For how to join and use it, see [Getting started](guides/getting-started.md); for our governance model, see the [Charter](governance/charter.md). ## How we got here diff --git a/governance/index.md b/governance/index.md new file mode 100644 index 0000000..1e3a05e --- /dev/null +++ b/governance/index.md @@ -0,0 +1,14 @@ +# Governance + +How the co-op decides things, and the agreements members share. + +## In this section + +- [Charter](charter.md) — the co-op's founding agreement +- [Code of conduct](code-of-conduct.md) — what we expect from each other +- [Terms of Service](terms-of-service.md) — the agreement covering use of the service +- [Privacy Policy](privacy-policy.md) — what we collect and why +- [How to make a proposal](make-a-proposal.md) — the path from an idea to a decision +- [Open questions](open-questions.md) — matters the co-op has not settled yet + +Operational roles sit in [Operations](../operations/). diff --git a/api-access.md b/guides/api-access.md similarity index 99% rename from api-access.md rename to guides/api-access.md index eb52213..8e6884c 100644 --- a/api-access.md +++ b/guides/api-access.md @@ -34,7 +34,7 @@ Two things worth being precise about: [model list](models.md) distinguishes policy-based zero retention from enclave-based protection. -Full detail, including what we can and cannot see: [privacy policy](governance/privacy-policy.md). +Full detail, including what we can and cannot see: [privacy policy](../governance/privacy-policy.md). ## Get a key diff --git a/energy.md b/guides/energy.md similarity index 100% rename from energy.md rename to guides/energy.md diff --git a/getting-started.md b/guides/getting-started.md similarity index 95% rename from getting-started.md rename to guides/getting-started.md index f544f16..e11bbab 100644 --- a/getting-started.md +++ b/guides/getting-started.md @@ -72,7 +72,7 @@ with the account you created in step 1. nothing lands in your history or our database. To make this your default, open **Settings → Conversations** and turn on **Default Temporary Chat**. For anything sensitive, we recommend a temporary chat — ideally paired with - a 🔒 enclave model. See [Privacy](governance/privacy-policy.md#4-what-we-can-see-an-honest-caveat)). + a 🔒 enclave model. See [Privacy](../governance/privacy-policy.md#4-what-we-can-see-an-honest-caveat)). Your usage draws from your monthly allowance; you can see it on the [Member Dashboard](https://dashboard.inference.coop). @@ -156,17 +156,17 @@ privacy, and direction happen on our **Loomio forum**: the co-op grows. - The updates feed is posted by the co-op's automation account. See - [Working with the agent](working-with-the-agent.md) for the agents behind + [Working with the agent](../operations/agentic-systems.md) for the agents behind it, what they do, and how members interact with them. -- See the [Charter](governance/charter.md) for how governance is structured. -- See [Open questions](governance/open-questions.md) for the decisions currently on the table. +- See the [Charter](../governance/charter.md) for how governance is structured. +- See [Open questions](../governance/open-questions.md) for the decisions currently on the table. ### Help build it Everything we run is open source, and members are welcome to contribute code, -documentation, and design. See [Infrastructure](infrastructure.md) for the map +documentation, and design. See [Infrastructure](../operations/infrastructure.md) for the map and the "Contributing" section for how to propose changes through [git.inference.coop](https://git.inference.coop). diff --git a/guest-access.md b/guides/guest-access.md similarity index 100% rename from guest-access.md rename to guides/guest-access.md diff --git a/guides/index.md b/guides/index.md new file mode 100644 index 0000000..7b821d7 --- /dev/null +++ b/guides/index.md @@ -0,0 +1,12 @@ +# Guides + +How to join, use the chat, choose a model, call the API, and understand what that +usage costs in energy and emissions. + +## In this section + +- [Getting started](getting-started.md) — join, use the chat, and get involved in governance. +- [Guest access](guest-access.md) — inviting someone without a full membership. +- [Models](models.md) — the catalogue of providers and models. +- [API access](api-access.md) — use the models programmatically. +- [Energy & carbon](energy.md) — the energy and emissions behind the service. diff --git a/models.md b/guides/models.md similarity index 99% rename from models.md rename to guides/models.md index 3cceed0..1515d88 100644 --- a/models.md +++ b/guides/models.md @@ -313,4 +313,4 @@ we commit not to. Requests made through the **API** with your own key are a different matter: those are **not stored on our side at all**, beyond the usage record needed for metering ([API access](api-access.md)). The full distinction — what's architecturally private versus what's a policy commitment — is in the -[Privacy Policy](governance/privacy-policy.md). \ No newline at end of file +[Privacy Policy](../governance/privacy-policy.md). \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index a24e5e9..e804ce2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -68,14 +68,19 @@ theme: nav: - Home: README.md - - Getting started: getting-started.md - - Guest access: guest-access.md - - Models: models.md - - API access: api-access.md - - Energy & carbon: energy.md - - Infrastructure: infrastructure.md - - Background: background.md - - Working with the agent: working-with-the-agent.md + - Guides: + - Overview: guides/index.md + - Getting started: guides/getting-started.md + - Guest access: guides/guest-access.md + - Models: guides/models.md + - API access: guides/api-access.md + - Energy & carbon: guides/energy.md + - Operations: + - Overview: operations/index.md + - Agentic systems: operations/agentic-systems.md + - Infrastructure: operations/infrastructure.md + - Roles: operations/roles.md + - Steward Policy: operations/steward-policy.md - Governance: - Overview: governance/index.md - Charter: governance/charter.md @@ -84,10 +89,7 @@ nav: - Terms of Service: governance/terms-of-service.md - Privacy Policy: governance/privacy-policy.md - How to make a proposal: governance/make-a-proposal.md - - Operations: - - Overview: operations/index.md - - Roles: operations/roles.md - - Steward Policy: operations/steward-policy.md + - Background: background.md plugins: # Built-in, offline search — the index is a JSON file in the build output. @@ -100,6 +102,13 @@ plugins: "open-questions.md": "governance/open-questions.md" "terms-of-service.md": "governance/terms-of-service.md" "privacy-policy.md": "governance/privacy-policy.md" + "getting-started.md": "guides/getting-started.md" + "guest-access.md": "guides/guest-access.md" + "models.md": "guides/models.md" + "api-access.md": "guides/api-access.md" + "energy.md": "guides/energy.md" + "infrastructure.md": "operations/infrastructure.md" + "working-with-the-agent.md": "operations/agentic-systems.md" hooks: # Rewrites directory-style links (e.g. [incidents/](incidents/)) to the diff --git a/working-with-the-agent.md b/operations/agentic-systems.md similarity index 100% rename from working-with-the-agent.md rename to operations/agentic-systems.md diff --git a/operations/index.md b/operations/index.md index 095b1f2..54f966e 100644 --- a/operations/index.md +++ b/operations/index.md @@ -1,7 +1,7 @@ # Operations -How the co-op runs its own work: who holds which role, what they are responsible for, -and the agreements that come with it. +How the co-op runs its own work: who holds which role, the agreements that come +with it, the stack it runs on, and the agents that work in it. ## In this section @@ -11,3 +11,5 @@ and the agreements that come with it. and rotated, their duties and privileged access, stipends, accountability and handover. More operational documents will land here as roles and procedures are agreed. +- [Agentic systems](agentic-systems.md) — what the co-op's agents do, who can instruct them, and what always needs a human. +- [Infrastructure](infrastructure.md) — a map of the stack and the codebase. diff --git a/infrastructure.md b/operations/infrastructure.md similarity index 99% rename from infrastructure.md rename to operations/infrastructure.md index 18d37f6..b1f72a0 100644 --- a/infrastructure.md +++ b/operations/infrastructure.md @@ -169,7 +169,7 @@ and ask for review. ## Models and providers The co-op serves models from multiple providers — Tinfoil for architectural -privacy, GreenPT and Regolo for renewable energy. See the [model list](models.md), +privacy, GreenPT and Regolo for renewable energy. See the [model list](../guides/models.md), the single source of truth for which models are available and how they're named. ## Security posture (plain language)