Records the membership poll that formally approved Nathan Schneider as general manager (closed 2026-10-30, 74 members voting), what the role does, and how roles are added or changed. Linked from the Operations index and the nav.
140 lines
4.6 KiB
YAML
140 lines
4.6 KiB
YAML
# MkDocs configuration for the member-readable documentation site.
|
|
#
|
|
# The documentation source stays exactly where it is — Markdown files at the
|
|
# repository root. This is a *publishing* layer over that source, not an edit
|
|
# of it. docs_dir is the repo root, so no document has to move for the
|
|
# generator to find it.
|
|
#
|
|
# Build: see publishing/build.sh
|
|
# Deploy: see publishing/deploy.sh
|
|
#
|
|
# Constraints baked in here:
|
|
# * theme.font: false -> Material must NOT pull Google Fonts.
|
|
# * fonts are self-hosted (publishing/fonts/) and OFL-licensed (Figtree).
|
|
# * no CDN / third-party host appears anywhere in the output.
|
|
|
|
site_name: Inference Cooperative docs
|
|
site_description: >-
|
|
Member-readable documentation for the Inference Cooperative: how to join and
|
|
use the service, the model catalogue, API access, governance and policies.
|
|
site_url: https://docs.inference.coop/
|
|
# MkDocs requires the docs directory to be a *child* of the config's directory
|
|
# and refuses to read the repository root directly. So the build stages the
|
|
# Markdown into .site-src/ (a generated, gitignored mirror of the documents)
|
|
# and renders that. No document is moved or rewritten in the repository — the
|
|
# staging copy exists only during the build.
|
|
docs_dir: .site-src
|
|
# Build output.
|
|
site_dir: .site-build
|
|
use_directory_urls: true
|
|
|
|
theme:
|
|
name: material
|
|
# Theme overrides. Used only to add a "documentation source" link to the
|
|
# footer on *every* page (overrides/partials/copyright.html) without putting
|
|
# it in the Markdown sources. No styling is changed here.
|
|
custom_dir: overrides
|
|
language: en
|
|
# Disable the theme's built-in Google Fonts loader. Without this, Material
|
|
# requests Roboto from fonts.googleapis.com / fonts.gstatic.com.
|
|
font: false
|
|
logo: publishing/logo.svg
|
|
favicon: publishing/logo.svg
|
|
palette:
|
|
# Light is listed first, so a fresh visitor gets the bright theme.
|
|
- media: "(prefers-color-scheme: light)"
|
|
scheme: default
|
|
primary: custom
|
|
accent: custom
|
|
toggle:
|
|
icon: material/weather-night
|
|
name: Switch to dark mode
|
|
- media: "(prefers-color-scheme: dark)"
|
|
scheme: slate
|
|
primary: custom
|
|
accent: custom
|
|
toggle:
|
|
icon: material/weather-sunny
|
|
name: Switch to light mode
|
|
features:
|
|
- navigation.tabs
|
|
- navigation.sections
|
|
- navigation.top
|
|
- navigation.indexes
|
|
- search.suggest
|
|
- search.highlight
|
|
- content.code.copy
|
|
- toc.integrate
|
|
|
|
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
|
|
- Governance:
|
|
- Overview: governance/index.md
|
|
- Charter: governance/charter.md
|
|
- Code of conduct: governance/code-of-conduct.md
|
|
- Open questions: governance/open-questions.md
|
|
- 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
|
|
|
|
plugins:
|
|
# Built-in, offline search — the index is a JSON file in the build output.
|
|
- search
|
|
# Built-in redirects — old governance URLs map into the governance/ folder.
|
|
- redirects:
|
|
redirect_maps:
|
|
"charter.md": "governance/charter.md"
|
|
"code-of-conduct.md": "governance/code-of-conduct.md"
|
|
"open-questions.md": "governance/open-questions.md"
|
|
"terms-of-service.md": "governance/terms-of-service.md"
|
|
"privacy-policy.md": "governance/privacy-policy.md"
|
|
|
|
hooks:
|
|
# Rewrites directory-style links (e.g. [incidents/](incidents/)) to the
|
|
# landing pages the build generates for them. Publishing-layer logic only.
|
|
- publishing/hooks.py
|
|
|
|
markdown_extensions:
|
|
- admonition
|
|
- attr_list
|
|
- md_in_html
|
|
- tables
|
|
- toc:
|
|
permalink: true
|
|
- pymdownx.details
|
|
- pymdownx.superfences
|
|
- pymdownx.tasklist:
|
|
custom_checkbox: true
|
|
|
|
extra_css:
|
|
# Co-op brand: palette from the website + self-hosted Figtree (SIL OFL 1.1).
|
|
- publishing/brand.css
|
|
- publishing/typography.css
|
|
|
|
# Keep build/tooling files out of the rendered site.
|
|
exclude_docs: |
|
|
.git/
|
|
*.sh
|
|
overrides/
|
|
publishing/README.md
|
|
publishing/requirements.txt
|
|
|
|
# Links to git.inference.coop (e.g. code-of-conduct.md in charter.md) are
|
|
# intentional absolute URLs; do not warn about them.
|
|
validation:
|
|
links:
|
|
absolute_links: ignore
|
|
unrecognized_links: ignore
|