Skip to content

Commit 5dff5e8

Browse files
Copilotmdheller
andauthored
fix: merge main, add markdownlint config, fix all MD lint errors
Agent-Logs-Url: https://github.com/SociOS-Linux/SourceOS/sessions/4fef94ad-d7b1-4b63-8920-eaadc44fc74d Co-authored-by: mdheller <21163552+mdheller@users.noreply.github.com>
1 parent a279c84 commit 5dff5e8

9 files changed

Lines changed: 35 additions & 4 deletions

File tree

.markdownlint.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"default": true,
3+
"MD013": false
4+
}

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Contributing
1+
# Contributing
22

33
- Spec-first: changes that affect behavior must update spec/.
44
- Keep SourceOS independent of socios by default.

SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Security
1+
# Security
22

33
Report vulnerabilities privately.
44

caps/semantic-search-bi/docs/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,25 @@ Canonical upstream for this contract package now lives in `SocioProphet/sherlock
44
This SourceOS copy is retained as a mirror/reference so local docs and tooling do not break, but changes should land upstream first.
55

66
This package defines contracts for a semantic search capability:
7+
78
- triRPC service surface (rpc/semantic.search.v0.yaml)
89
- topic taxonomy for event bus integration (topics/*.yaml)
910
- JSON Schemas for payload validation (schemas/*.json)
1011
- a local validator (tools/validate_package.py)
1112

1213
## Non-goals
14+
1315
This package does **not** ship any runtime implementation.
1416
Implementations live in separate packages and MUST:
17+
1518
1) enforce a policy guard (default deny)
1619
2) emit governance evidence events
1720
3) speak triRPC for all method surfaces
1821

1922
## Optional backends
23+
2024
Implementations MAY provide:
25+
2126
- Lexical inverted index (e.g., Xapian)
2227
- Vector ANN index (e.g., FAISS/HNSW)
2328
- Symbolic graph store (e.g., AtomSpace)

docs/BOUNDARIES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Boundaries
1+
# Boundaries
22

33
- SourceOS: OS + local policy/attestations.
44
- socios: opt-in community automation layer (updates/CI/CD/training).

docs/adr/0001-silverblue-toolbx-flatpak-podman.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,18 @@
33
Status: proposed
44

55
Decision:
6+
67
- Use Fedora Silverblue (GNOME) as workstation base.
78
- Use Toolbx for dev environments.
89
- Use Flatpak for GUI apps.
910
- Use rootless Podman for services.
1011

1112
Why:
13+
1214
- Immutable base reduces drift.
1315
- User-space isolation avoids breaking system environments (PEP 668-style issues).
1416
- Sandboxed GUI reduces app-level blast radius.
1517

1618
Consequences:
19+
1720
- We must provide first-class tooling to make user-space ergonomics excellent.
Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,9 @@
1-
# Compression Commons (v0)\n\nUnifies:\n- Vanity Press Economy metrics (subsidy gradient, seigniorage, paper-mill equilibrium)\n- Lawful Learning constraints (projection to feasibility + replay evidence)\n- SourceOS enforcement (CapD + Triune RPC + policy guards + evidence ledger)\n\nThis module defines contracts first; reference implementations are optional.\n
1+
# Compression Commons (v0)
2+
3+
Unifies:
4+
5+
- Vanity Press Economy metrics (subsidy gradient, seigniorage, paper-mill equilibrium)
6+
- Lawful Learning constraints (projection to feasibility + replay evidence)
7+
- SourceOS enforcement (CapD + Triune RPC + policy guards + evidence ledger)
8+
9+
This module defines contracts first; reference implementations are optional.

docs/semantic-search/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,22 @@ When updating the semantic-search contract, update `sherlock-search` first and t
77
This directory explains the **Semantic Search** capability contract in plain English.
88

99
## What this is
10+
1011
This package defines a **contract-only capability**: it specifies *interfaces* (schemas, RPC surface, topics, governance hooks),
1112
but **does not ship an implementation**. It’s like a “power outlet standard” — vendors can build compatible devices, but the
1213
contract itself isn’t the device.
1314

1415
## Why we do it this way
16+
1517
We want capabilities that are:
18+
1619
- **Composable**: other capabilities can depend on this one without importing a specific engine.
1720
- **Auditable**: every call can be policy-guarded and emits evidence events.
1821
- **Replaceable**: Xapian/FAISS/AtomSpace/etc. are optional implementations behind the same stable interface.
1922
- **Linux-first** and open-source-only.
2023

2124
## What’s in the contract package
25+
2226
The capability contract is defined by these folders:
2327

2428
- `capd/` (if present): Capability descriptor (identity, version, requirements, compatibility rules).
@@ -28,19 +32,24 @@ The capability contract is defined by these folders:
2832
- `tools/validate_package.py`: A local validator that ensures the contract package is structurally sane.
2933

3034
## Governance requirements (non-negotiable)
35+
3136
Every implementation of this contract MUST:
37+
3238
1) Enforce **policy guards** (default deny) for ingest/query/delete.
3339
2) Emit **evidence events** for every meaningful action (ingest accepted/rejected, query executed, results delivered, deletes).
3440
3) Support **quota + identity hooks** (caller identity / tenant / namespace).
3541
4) Be compatible with triRPC request/response schema validation.
3642

3743
## How to read the contract
44+
3845
Start at:
46+
3947
- `rpc/semantic.search.v0.yaml` — the canonical RPC surface
4048
- `schemas/query_request.schema.json` and `schemas/query_response.schema.json`
4149
- `schemas/evidence_event.schema.json` — what we log as auditable evidence
4250
- `topics/semantic.search.topics.v0.yaml` — pubsub surfaces
4351

4452
## “BI” naming note
53+
4554
If the folder is `caps/semantic-search-bi`, “bi” should mean *behavioral indexing* (or whatever we intended),
4655
not “business intelligence”. If that’s not what we mean, we should rename now while it’s early.

docs/semantic-search/UPSTREAM.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,11 @@
33
Canonical repository: `SocioProphet/sherlock-search`
44

55
Canonical PR that moved ownership upstream:
6+
67
- `SocioProphet/sherlock-search#1`
78

89
Policy for updates:
10+
911
1. Change the contract in `sherlock-search` first.
1012
2. Validate there.
1113
3. Mirror here only if SourceOS needs a local reference copy.

0 commit comments

Comments
 (0)