docs(solver): KCSolve architecture, API reference, and server specification #300

forbes · 2026-02-20T18:03:18Z

forbes commented

2026-02-20 18:03:18 +00:00

Summary

Documentation for the KCSolve pluggable solver system — architecture overview, Python API reference, and Silo server integration specification.

Commits

docs: sync Silo server documentation — Update Silo server module docs and frontend spec
docs: KCSolve architecture and Python API reference — Add INTER_SOLVER.md (internal solver design doc matching as-built implementation), ondsel-solver.md (architecture overview), kcsolve-python.md (Python API reference), update SUMMARY.md
docs(kcsolve): expand Python API reference — Full method docs for all IKCSolver virtuals, SolverRegistry functions, type constructors, and enum values
docs(solver): server specification for KCSolve solver service — Add SOLVER.md with Phase 3 server integration spec: API endpoints, JSON schemas (SolveContext/SolveResult), runner protocol, solver registry, result storage, and client integration

Files changed

File	Change
`docs/INTER_SOLVER.md`	New — internal solver design doc (rewritten to match as-built)
`docs/src/architecture/ondsel-solver.md`	Updated — architecture overview
`docs/src/reference/kcsolve-python.md`	New — Python API reference
`docs/src/silo-server/SOLVER.md`	New — server integration specification
`docs/src/silo-server/MODULES.md`	Updated — module docs sync
`docs/src/silo-server/frontend-spec.md`	Updated — frontend spec sync
`docs/src/silo-server/overview.md`	Updated — overview sync
`docs/src/SUMMARY.md`	Updated — mdbook navigation entries

No code changes — documentation only.

## Summary Documentation for the KCSolve pluggable solver system — architecture overview, Python API reference, and Silo server integration specification. ## Commits 1. **docs: sync Silo server documentation** — Update Silo server module docs and frontend spec 2. **docs: KCSolve architecture and Python API reference** — Add `INTER_SOLVER.md` (internal solver design doc matching as-built implementation), `ondsel-solver.md` (architecture overview), `kcsolve-python.md` (Python API reference), update `SUMMARY.md` 3. **docs(kcsolve): expand Python API reference** — Full method docs for all IKCSolver virtuals, SolverRegistry functions, type constructors, and enum values 4. **docs(solver): server specification for KCSolve solver service** — Add `SOLVER.md` with Phase 3 server integration spec: API endpoints, JSON schemas (SolveContext/SolveResult), runner protocol, solver registry, result storage, and client integration ## Files changed | File | Change | |------|--------| | `docs/INTER_SOLVER.md` | New — internal solver design doc (rewritten to match as-built) | | `docs/src/architecture/ondsel-solver.md` | Updated — architecture overview | | `docs/src/reference/kcsolve-python.md` | New — Python API reference | | `docs/src/silo-server/SOLVER.md` | New — server integration specification | | `docs/src/silo-server/MODULES.md` | Updated — module docs sync | | `docs/src/silo-server/frontend-spec.md` | Updated — frontend spec sync | | `docs/src/silo-server/overview.md` | Updated — overview sync | | `docs/src/SUMMARY.md` | Updated — mdbook navigation entries | No code changes — documentation only.

forbes added 4 commits 2026-02-20 18:03:20 +00:00

docs: sync Silo server documentation c0ee4ecccf

Auto-synced from kindred/silo main branch.

docs: KCSolve architecture and Python API reference 98b0f72352

- Replace OndselSolver architecture doc with KCSolve pluggable solver
  architecture covering IKCSolver interface, SolverRegistry, OndselAdapter,
  Python bindings, file layout, and testing
- Add kcsolve Python API reference with full type documentation, module
  functions, usage examples, and pybind11 vector-copy caveat
- Add INTER_SOLVER.md spec (previously untracked) with Phase 1 and Phase 2
  marked as complete
- Update SUMMARY.md with new page links

docs(kcsolve): expand Python API reference with full method docs 315ac2a25d

Expand SolveContext field descriptions (motions, simulation, bundle_fixed),
Constraint params table, marker explanations, Constraint.Limit descriptions,
MotionDef field descriptions, SimulationParams field descriptions, and all
optional IKCSolver methods with signatures, parameter docs, and usage
examples (interactive drag protocol, kinematic simulation, diagnostics,
export_native, capability queries).

docs(solver): server specification for KCSolve solver service

Build and Test / build (pull_request) Successful in 30m11s

Details

64fbc167f7

Comprehensive specification covering:
- Architecture: solver module integrated into Silo's job queue system
- Data model: JSON schemas for SolveContext and SolveResult transport
- REST API: submit, status, list, cancel endpoints under /api/solver/
- SSE events: solver.created, solver.progress, solver.completed, solver.failed
- Runner integration: standalone kcsolve execution, capability reporting
- Job definitions: manual solve, commit-time validation, kinematic simulation
- SolveContext extraction: headless Create and .kc archive packing
- Database schema: solver_results table with per-revision result caching
- Configuration: server and runner config patterns
- Security: input validation, runner isolation, authentication
- Client SDK: Python client and Create workbench integration sketches
- Implementation plan: Phase 3a-3e breakdown

forbes added 1 commit 2026-02-20 18:03:58 +00:00

Merge branch 'main' into docs/solver-spec-update

Build and Test / build (pull_request) Successful in 30m48s

Details

84f83a9d18

forbes merged commit 7dc7aac935 into main

2026-02-20 18:04:14 +00:00

forbes deleted branch docs/solver-spec-update

2026-02-20 18:04:14 +00:00

forbes referenced this issue from a commit

2026-02-20 18:04:17 +00:00

Merge pull request 'docs(solver): KCSolve architecture, API reference, and server specification' (#300) from docs/solver-spec-update into main

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: kindred/create#300