|
| 1 | +# Intent |
| 2 | + |
| 3 | +## Status |
| 4 | + |
| 5 | +Knowledge-as-Code is an internal-first open utility maintained by PAICE.work PBC. It is used inside the PAICE and Snap Synapse portfolios and published under MIT so others can inspect, reuse, and improve it. |
| 6 | + |
| 7 | +The project is not pursuing broad developer mindshare as an end in itself. Public adoption is useful when it demonstrates that the generator transfers to a new domain without maintainer interpretation. |
| 8 | + |
| 9 | +## Purpose |
| 10 | + |
| 11 | +Maintain a small, portable generator for evidence-backed structured references that need: |
| 12 | + |
| 13 | +- Git-tracked source files readable without proprietary tooling |
| 14 | +- a configurable Primary, Container, Authority, and Secondary entity model |
| 15 | +- deterministic validation, drift detection, and reproducible output |
| 16 | +- a static human-readable site and JSON API from the same source |
| 17 | +- an optional local MCP interface |
| 18 | + |
| 19 | +## Intended users |
| 20 | + |
| 21 | +The narrow primary audience is a technically capable maintainer who owns a reference dataset, needs evidence and review dates to remain visible, and wants to publish without a database or hosted application runtime. |
| 22 | + |
| 23 | +The project is a poor fit for collaborative editing by nontechnical teams, transactional applications, high-volume ingestion, or knowledge domains without a stable ontology. |
| 24 | + |
| 25 | +## Operating model |
| 26 | + |
| 27 | +- Internal portfolio use funds the maintenance floor. |
| 28 | +- The clean initializer is the supported adoption path. |
| 29 | +- The example is a testable teaching fixture, not an authoritative security reference. |
| 30 | +- Public support is best effort with no response-time commitment. |
| 31 | +- Correctness, security, portability, and the supported golden path take priority over feature breadth. |
| 32 | +- Integrations belong behind documented provider-independent contracts. |
| 33 | + |
| 34 | +## Viable open-repository end state |
| 35 | + |
| 36 | +The repository is sustainable when it remains useful internally even if external adoption is zero, while an independent user can still understand, initialize, verify, build, and deploy it from public documentation alone. |
| 37 | + |
| 38 | +A mature end state has: |
| 39 | + |
| 40 | +- one stable 1.x generator and initializer |
| 41 | +- zero required runtime dependencies beyond supported Node.js |
| 42 | +- a bounded compatibility and security policy |
| 43 | +- reproducible tests for the public golden path |
| 44 | +- a small release surface driven by internal needs, security findings, and independently reproduced user problems |
| 45 | +- documented extension contracts instead of bundled vendor integrations |
| 46 | +- no implied service-level agreement, community roadmap, or obligation to accept features |
| 47 | + |
| 48 | +## Adoption evidence |
| 49 | + |
| 50 | +Repository traffic, stars, social engagement, and maintainer-assisted demos are weak signals. The meaningful gate is an external pilot completed without live maintainer help. See `ADOPTION.md`. |
| 51 | + |
| 52 | +Until that gate is passed, claims should say the project is used internally and available for external reuse. They should not imply independent adoption. |
| 53 | + |
| 54 | +## Recalibration gates |
| 55 | + |
| 56 | +- If the initializer cannot create a working project from a clean checkout, stop feature work and restore the golden path. |
| 57 | +- If internal users stop using the generator, reassess whether the repository should enter maintenance-only status. |
| 58 | +- If three independent pilots complete the golden path and request the same extension, consider it for the core. |
| 59 | +- If an extension benefits only one deployment, keep it outside the core behind a documented contract. |
| 60 | +- If maintenance cost exceeds internal value, preserve the last working release and archive the repository transparently. |
| 61 | + |
| 62 | +## Non-goals |
| 63 | + |
| 64 | +- Becoming a general-purpose knowledge-management platform |
| 65 | +- Bundling an AI provider or hosted verification service |
| 66 | +- Maintaining domain data on behalf of downstream users |
| 67 | +- Optimizing for stars, launch traffic, or speculative integrations |
| 68 | +- Promising a fixed release cadence |
| 69 | + |
| 70 | +## Exceptions to Repo Standards |
| 71 | + |
| 72 | +None currently recorded. |
| 73 | + |
| 74 | +## Changelog |
| 75 | + |
| 76 | +- 2026-07-21: Recalibrated the project from adoption-seeking template to internal-first open utility; made independent transfer the public adoption gate. |
0 commit comments