theam / theam/facility

Document hidden capabilities — the learning proposal platform and the governed loop

Open
#20 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation priority:normal
Dominant language
TypeScript
Stars
71
Forks
64
Avg merge
15h 38m
Merged PRs (30d)
66

Description

Several powerful capabilities exist but are effectively invisible: if they are not documented, they are neither known nor used.

Scope

  • The learning proposal platform: how runs generate skill, rule and knowledge proposals; the approval, immutable activation and canary flow; and how later runs consume approved artifacts.
  • Receipts and the integrity chain: what a receipt proves and where to find it.
  • The security agent: its read-only report and the trusted issue-projection model.
  • The doctor: what it checks and how to read a verdict.
  • Lanes and gates: one conceptual page mapping issue → architect → approval → builder → review → merge → outcome.

Audience-first: write for a team adopting the platform, not for its authors. Feed real onboarding questions from new adopters back into these pages.

Acceptance

  • Each capability above has a page reachable from the docs navigation.
  • The learning proposal flow is demonstrated with screenshots from a real run.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the documentation navigation and reviewing a real run that demonstrates the learning proposal flow. Map the requested capabilities into audience-focused pages, make each page reachable from navigation, and verify that the proposal flow includes screenshots from that run.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.