apunkt/plano
1
0
Fork 0
mirror of https://github.com/katanemo/plano.git synced 2026-04-30 03:16:28 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
plano/docs
History
Syed Hashmi cea43c5da5
docs: address signals flywheel review feedback 
Addresses review comments on #910:

- Shorten the paper citation to (Chen et al., 2026) per common cite
  practice (replacing the full author list form).
- Replace the Why Signals Matter section with the review-suggested
  rewrite verbatim: more formal intro framing, renumbered steps to
  Instrument / Sample & triage / Data Construction / Model Optimization
  / Deploy, removes 'routing decisions' from the data-construction
  step, and adds DPO/RLHF/SFT as model-optimization examples.
- Renders tau and O(messages) as proper math glyphs via the sphinx
  built-in :math: role (enabled by adding sphinx.ext.mathjax to
  conf.py). Using the RST role form rather than raw $...$ inline so
  sphinx only injects MathJax on pages that actually have math,
  instead of loading ~1MB of JS on every page.

Build verified locally: sphinx-build produces no warnings on the
changed files and the rendered HTML wraps tau and O(messages) in
MathJax-ready <span class="math">\(\tau\)</span> containers.

Made-with: Cursor
2026-04-24 12:05:48 -07:00
..
source docs: address signals flywheel review feedback 2026-04-24 12:05:48 -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.