apunkt/plano
1
0
Fork 0
mirror of https://github.com/katanemo/plano.git synced 2026-05-01 20:03:40 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
plano/docs
History
Syed Hashmi ae629d3635
docs: reframe signals intro around the improvement flywheel 
Addresses review feedback on #910:

- Replace the triage-only framing at the top with an instrument -> sample
  & triage -> construct data -> optimize -> deploy flywheel that explains
  why signals matter, not just what they surface. Paper's 82% / 1.52x
  numbers move into step 2 of the flywheel where they belong.
- Remove the 'Signals vs Response Quality' section. Per review, signals
  and response quality overlap rather than complement each other, so the
  comparison is misleading.
- Borrow the per-category summaries and leaf-type descriptions verbatim
  from the katanemo/signals reference implementation (module docstrings)
  so the documentation and the detector contract stay in sync. Drops the
  hand-crafted examples that were not strictly accurate (e.g. 'semantic
  overlap is high' for rephrase, 'user explicitly corrects the agent'
  for correction).

Made-with: Cursor
2026-04-24 10:59:37 -07:00
..
source docs: reframe signals intro around the improvement flywheel 2026-04-24 10:59:37 -07:00
build_docs.sh fix build break (#730) 2026-02-09 10:08:20 -08:00
CNAME Update docs to Plano (#639) 2025-12-23 17:14:50 -08:00
Dockerfile fix build break (#730) 2026-02-09 10:08:20 -08:00
Makefile Docs branch - v1 of our tech docs (#69) 2024-09-20 17:08:42 -07:00
README.md add readme and docker build (#81) 2024-09-25 10:05:59 -07:00
requirements.txt Doc Update (#129) 2024-10-06 16:54:34 -07:00
routing-api.md Model affinity for consistent model selection in agentic loops (#827) 2026-04-08 17:32:02 -07:00

README.md

Generate HTML from reStructuredText files

To generate docs execute following command,

sh build_docs.sh

Requirements

This build system requires docker to be intsalled and running locally.