Documentation test matrix¶
Generated by scripts/docs-matrix.py; the gate runs --check, so a row that stops being
true fails the build. Each tick stands on something in the tree:
| Column | The tick means |
|---|---|
| Documentation | the page exists, and mkdocs.yml reaches it |
| Example | a file under examples/ names a marker the area owns |
| Diagram | the area's page carries a Mermaid diagram |
| Validated | a test file names the area's namespace, and the documentation test runs |
A column with no evidence prints - rather than a tick, and the notes below the table
name the file each tick stands on, so a row can be audited without trusting a script.
| Area | Documentation | Example | Diagram | Validated |
|---|---|---|---|---|
| Authentication | ✓ | ✓ | ✓ | ✓ |
| SecurityContext | ✓ | ✓ | ✓ | ✓ |
| Authorization | ✓ | ✓ | ✓ | ✓ |
| Tenancy | ✓ | ✓ | ✓ | ✓ |
| Privileges | ✓ | ✓ | ✓ | ✓ |
| PostgreSQL | ✓ | ✓ | ✓ | ✓ |
| Neo4j | ✓ | ✓ | ✓ | ✓ |
| MCP | ✓ | ✓ | ✓ | ✓ |
| Audit | ✓ | ✓ | ✓ | ✓ |
| Reliability | ✓ | ✓ | ✓ | ✓ |
| Observability | ✓ | ✓ | ✓ | ✓ |
| Errors | ✓ | ✓ | ✓ | ✓ |
| Health | ✓ | ✓ | ✓ | ✓ |
| Operations | ✓ | ✓ | ✓ | ✓ |
What each row stands on¶
- Authentication -
jdlib.authn- documentation: jdlib/features/authentication.md; example: examples/enterprise/app/security/authentication.py; diagram: architecture/security-architecture.md; validated: tests/infra/test_zitadel_infra.py (+ the documentation test). - SecurityContext -
jdlib.security.context- documentation: jdlib/features/tenancy.md; example: examples/enterprise/app/graph.py; diagram: architecture/security-architecture.md; validated: tests/integration/test_audit_isolation_export.py (+ the documentation test). - Authorization -
jdlib.authz- documentation: jdlib/features/authorization.md; example: examples/enterprise/app/main.py; diagram: architecture/security-architecture.md; validated: tests/integration/test_access_bindings.py (+ the documentation test). - Tenancy -
jdlib.tenancy- documentation: jdlib/features/tenancy.md; example: examples/enterprise/app/main.py; diagram: architecture/data-architecture.md; validated: tests/infra/test_kong_infra.py (+ the documentation test). - Privileges -
jdlib.authz.permissions- documentation: jdlib/features/authorization.md; example: examples/enterprise/app/main.py; diagram: architecture/security-architecture.md; validated: tests/integration/test_access_bindings.py (+ the documentation test). - PostgreSQL -
jdlib.data.postgres- documentation: jdlib/features/connectors.md; example: examples/enterprise/README.md; diagram: architecture/data-architecture.md; validated: tests/integration/test_postgres_connector.py (+ the documentation test). - Neo4j -
jdlib.graph- documentation: jdlib/features/graph.md; example: examples/enterprise/app/graph.py; diagram: architecture/data-architecture.md; validated: tests/infra/test_neo4j_infra.py (+ the documentation test). - MCP -
jdlib.integrations.mcp- documentation: jdlib/features/mcp.md; example: examples/enterprise/app/mcp/server.py; diagram: jdlib/features/mcp.md; validated: tests/unit/test_mcp_adversarial.py (+ the documentation test). - Audit -
jdlib.security.audit- documentation: jdlib/features/audit.md; example: examples/enterprise/app/mcp/server.py; diagram: architecture/security-architecture.md; validated: tests/integration/test_audit_isolation_export.py (+ the documentation test). - Reliability -
jdlib.reliability- documentation: reliability/overview.md; example: examples/enterprise/app/configuration/settings.py; diagram: architecture/reliability-architecture.md; validated: tests/integration/test_error_envelope_contract.py (+ the documentation test). - Observability -
jdlib.security.tracing- documentation: jdlib/features/observability.md; example: examples/enterprise/README.md; diagram: architecture/observability-architecture.md; validated: tests/infra/test_otel_infra.py (+ the documentation test). - Errors -
jdlib.security.errors- documentation: reference/error-codes.md; example: examples/enterprise/tests/unit/test_app.py; diagram: architecture/request-lifecycle.md; validated: tests/unit/security/test_authz_pep.py (+ the documentation test). - Health -
jdlib.integrations.fastapi- documentation: operations/health-and-readiness.md; example: examples/enterprise/README.md; diagram: architecture/request-lifecycle.md; validated: tests/integration/test_error_envelope_contract.py (+ the documentation test). - Operations -
jdlib.integrations.cli- documentation: operations/deployment.md; example: examples/enterprise/README.md; diagram: operations/deployment.md; validated: tests/integration/test_cli_integration.py (+ the documentation test).
Areas documented beyond the directive's list¶
The directive says to update this matrix from the implementation. The portal also documents these, each with a page and tests, and they are not forced into the rows above: caching, credentials, connectors, jobs, query system, resource management, storage (see Features) and the graph plane's tenant isolation (see Graph).
Regenerate with python scripts/docs-matrix.py; the documentation test fails when thispage
is stale.