stwaidele/dorfteich
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases 22 Wiki Activity
627f128ab8
dorfteich/docs/manual/README.md
Claude Fable 5 eeb0ef6794
All checks were successful
CD / Build and push images (push) Successful in 1m9s
Details
CD / Deploy to Test (push) Successful in 10s
Details
CD / Smoke tests against Test (push) Successful in 1m10s
Details
CD / Promote to Int (push) Successful in 11s
Details
CI / Lint, typecheck, test (push) Successful in 4m7s
Details
CI / Build container images (push) Has been skipped
Details
CI / Auth e2e pack (push) Successful in 5m34s
Details
CI / Import/export fidelity gate (push) Successful in 47s
Details
Documentation set: features, manuals (user/pond-admin/site-admin), API, MCP, developer guide 
Seven audience-targeted documents (English first, German translation to
follow), linked from the README and a new docs/manual/ index:

- docs/features.md — public-facing feature overview: what Dorfteich
  can do and why that matters
- docs/manual/user-guide.md — everyday use: editor, wikilinks, labels,
  search, comments, watches/digests, import/export, settings
- docs/manual/pond-admin-guide.md — pond configuration: members/roles,
  access rules incl. label scoping and public pages, labels, comment
  policy, plugins, API/MCP opt-ins, files, export
- docs/manual/site-admin-guide.md — instance administration: wizard,
  settings, quotas, uploads, API/MCP switches, legal pages, plugins,
  users, and the system panel (jobs/backups/audit/storage)
- docs/manual/api-guide.md — example-driven public-API walkthrough
  (tokens, reading, writing through the collab-safe path, labels,
  comments, error semantics)
- docs/manual/mcp-guide.md — connecting AI assistants: switches, token
  scopes, Claude Code one-liner, mcp-remote bridge, tool table, audit
  and safety properties
- docs/developer/extending.md — plugin development (sandbox contract,
  SDK, block plugins, bundled apps/fullscreen, shipping) and core
  contributions (stack, dev environment, gates, house rules)

README: documentation index, repository-layout rows for docs/manual and
docs/developer, and the stale "architecture phase" status brought up to
reality. All relative links verified.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01EwZ4jR4KFAPvpjWevfUGX1
2026-07-12 17:18:30 +02:00

1.1 KiB
Raw Blame History

Dorfteich manuals

User-facing documentation, by audience. (German translations are planned; English is authoritative for now.)

Guide For
Feature overview anyone wondering what Dorfteich is
User guide everyday members
Pond-admin guide people administering a pond
Site-admin guide instance administrators
API guide scripts and integrations
MCP guide connecting AI assistants
Developer guide plugin authors and core contributors

Operating an instance (install, update, backup, monitoring): self-hosting. Internals: architecture.