docs: reorganise into Guides / Operations / Governance
- Guides/: getting started, guest access, models, API access, energy & carbon - Operations/: agentic systems (was 'working with the agent'), infrastructure, roles, steward policy - Governance/: unchanged, now with its overview page Lateral links and the homepage updated; redirects keep the old root URLs alive.
This commit is contained in:
1 parent
a6142d68f2
commit
ac8cac02c6
13 files changed
+66
-29
No files matched your search
@@ -10,13 +10,13 @@ funded through our [Open Collective](https://opencollective.com/inference-cooper
|
|||||||
|
|
||||||
## Start here
|
## 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.
|
- **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.
|
- **Which models can I use?** → [Models](guides/models.md) — the full catalog of providers and models.
|
||||||
- **Want API access?** → [API access](api-access.md) — use our models programmatically.
|
- **Want API access?** → [API access](guides/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.
|
- **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](infrastructure.md) — a map of the stack and the codebase.
|
- **Curious how it works?** → [Infrastructure](operations/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.
|
- **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.
|
- **Need help or have an idea?** → [Support & feature requests](https://git.inference.coop/co-op/support) — open an issue.
|
||||||
|
|
||||||
## Key links
|
## Key links
|
||||||
|
|||||||
+1
-1
@@ -9,7 +9,7 @@ together.
|
|||||||
We are a small cooperative by design, fiscally sponsored by the nonprofit
|
We are a small cooperative by design, fiscally sponsored by the nonprofit
|
||||||
[Metagov](https://metagov.org) and managing member dues on
|
[Metagov](https://metagov.org) and managing member dues on
|
||||||
[Open Collective](https://opencollective.com/inference-cooperative).
|
[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).
|
for our governance model, see the [Charter](governance/charter.md).
|
||||||
|
|
||||||
## How we got here
|
## How we got here
|
||||||
|
|||||||
@@ -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/).
|
||||||
@@ -34,7 +34,7 @@ Two things worth being precise about:
|
|||||||
[model list](models.md) distinguishes policy-based zero retention from
|
[model list](models.md) distinguishes policy-based zero retention from
|
||||||
enclave-based protection.
|
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
|
## Get a key
|
||||||
|
|
||||||
File renamed without changes.
@@ -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,
|
nothing lands in your history or our database. To make this your default,
|
||||||
open **Settings → Conversations** and turn on **Default Temporary Chat**.
|
open **Settings → Conversations** and turn on **Default Temporary Chat**.
|
||||||
For anything sensitive, we recommend a temporary chat — ideally paired with
|
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
|
Your usage draws from your monthly allowance; you can see it on the
|
||||||
[Member Dashboard](https://dashboard.inference.coop).
|
[Member Dashboard](https://dashboard.inference.coop).
|
||||||
@@ -156,17 +156,17 @@ privacy, and direction happen on our **Loomio forum**:
|
|||||||
the co-op grows.
|
the co-op grows.
|
||||||
|
|
||||||
- The updates feed is posted by the co-op's automation account. See
|
- 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.
|
it, what they do, and how members interact with them.
|
||||||
|
|
||||||
- See the [Charter](governance/charter.md) for how governance is structured.
|
- 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 [Open questions](../governance/open-questions.md) for the decisions currently on the table.
|
||||||
|
|
||||||
|
|
||||||
### Help build it
|
### Help build it
|
||||||
|
|
||||||
Everything we run is open source, and members are welcome to contribute code,
|
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
|
and the "Contributing" section for how to propose changes through
|
||||||
[git.inference.coop](https://git.inference.coop).
|
[git.inference.coop](https://git.inference.coop).
|
||||||
|
|
||||||
File renamed without changes.
@@ -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.
|
||||||
@@ -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
|
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 —
|
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
|
what's architecturally private versus what's a policy commitment — is in the
|
||||||
[Privacy Policy](governance/privacy-policy.md).
|
[Privacy Policy](../governance/privacy-policy.md).
|
||||||
+21
-12
@@ -68,14 +68,19 @@ theme:
|
|||||||
|
|
||||||
nav:
|
nav:
|
||||||
- Home: README.md
|
- Home: README.md
|
||||||
- Getting started: getting-started.md
|
- Guides:
|
||||||
- Guest access: guest-access.md
|
- Overview: guides/index.md
|
||||||
- Models: models.md
|
- Getting started: guides/getting-started.md
|
||||||
- API access: api-access.md
|
- Guest access: guides/guest-access.md
|
||||||
- Energy & carbon: energy.md
|
- Models: guides/models.md
|
||||||
- Infrastructure: infrastructure.md
|
- API access: guides/api-access.md
|
||||||
- Background: background.md
|
- Energy & carbon: guides/energy.md
|
||||||
- Working with the agent: working-with-the-agent.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:
|
- Governance:
|
||||||
- Overview: governance/index.md
|
- Overview: governance/index.md
|
||||||
- Charter: governance/charter.md
|
- Charter: governance/charter.md
|
||||||
@@ -84,10 +89,7 @@ nav:
|
|||||||
- Terms of Service: governance/terms-of-service.md
|
- Terms of Service: governance/terms-of-service.md
|
||||||
- Privacy Policy: governance/privacy-policy.md
|
- Privacy Policy: governance/privacy-policy.md
|
||||||
- How to make a proposal: governance/make-a-proposal.md
|
- How to make a proposal: governance/make-a-proposal.md
|
||||||
- Operations:
|
- Background: background.md
|
||||||
- Overview: operations/index.md
|
|
||||||
- Roles: operations/roles.md
|
|
||||||
- Steward Policy: operations/steward-policy.md
|
|
||||||
|
|
||||||
plugins:
|
plugins:
|
||||||
# Built-in, offline search — the index is a JSON file in the build output.
|
# 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"
|
"open-questions.md": "governance/open-questions.md"
|
||||||
"terms-of-service.md": "governance/terms-of-service.md"
|
"terms-of-service.md": "governance/terms-of-service.md"
|
||||||
"privacy-policy.md": "governance/privacy-policy.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:
|
hooks:
|
||||||
# Rewrites directory-style links (e.g. [incidents/](incidents/)) to the
|
# Rewrites directory-style links (e.g. [incidents/](incidents/)) to the
|
||||||
|
|||||||
File renamed without changes.
+4
-2
@@ -1,7 +1,7 @@
|
|||||||
# Operations
|
# Operations
|
||||||
|
|
||||||
How the co-op runs its own work: who holds which role, what they are responsible for,
|
How the co-op runs its own work: who holds which role, the agreements that come
|
||||||
and the agreements that come with it.
|
with it, the stack it runs on, and the agents that work in it.
|
||||||
|
|
||||||
## In this section
|
## 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.
|
and rotated, their duties and privileged access, stipends, accountability and handover.
|
||||||
|
|
||||||
More operational documents will land here as roles and procedures are agreed.
|
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.
|
||||||
@@ -169,7 +169,7 @@ and ask for review.
|
|||||||
## Models and providers
|
## Models and providers
|
||||||
|
|
||||||
The co-op serves models from multiple providers — Tinfoil for architectural
|
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.
|
the single source of truth for which models are available and how they're named.
|
||||||
|
|
||||||
## Security posture (plain language)
|
## Security posture (plain language)
|
||||||
Reference in new issue
Block a user