Skip to content

armgit / ODS

Public Imported from GitHub
0

ODS V3 Pre-Release: Public testing and refinement ahead of the official V3 launch. Turn your PC, Mac, or Linux box into a private AI server.

7.8 KB
Raw Blame

title: Pixel documentation doc_type: reference audience: [owner, operator, contributor, security-reviewer, maintainer] feature_status: mixed owners: [documentation] sources_of_truth: [README.md, pixel, RELEASE-MANIFEST.json, QUALIFICATION-MATRIX.json, OPENCLAW-COMPATIBILITY.json] last_verified_at: 2026-08-27

Pixel documentation

Start with the job you need to do. Status words in these pages are evidence boundaries, not marketing labels: source presence, an authored test, or a generated receipt does not by itself prove support, deployment, or live acceptance.

Start here

Your job Start with Then use
Understand what this checkout claims Current status Repository README and qualification contract
Install or evaluate Pixel Requirements and clean-host quickstart First deployment and post-install checklist
Configure or customize Pixel Configuration source map Configuration overview, extension chooser, and client onboarding
Find a command CLI reference The command's guide, preview, or help output
Understand a data contract Schema catalog The linked schema and its owning component
Use Pixel for the first time First real conversation Status and evidence
Operate or recover Pixel Operations runbook Upgrade and rollback, incident response, and support packet
Review security and privacy Security overview Threat model and security assurance
Change code or docs Contributing Documentation contract and architecture
Review release or qualification evidence Qualification Compatibility record and the exact versioned live audit linked from status

Current foundation

The index, status, CLI, schema, and configuration pages are additive. Existing root guides remain in place while their contracts and inbound links are audited. Versioned live audits, compatibility files, qualification records, and release artifacts have not been moved.

Owner journey

  1. Check the host and private-input requirements.
  2. Follow the clean-host quickstart.
  3. Use the first-deployment decision tree for only the enabled limbs.
  4. Complete client onboarding and handoff when another owner/client will operate the deployment.
  5. Complete the post-install checklist.
  6. Run a first real configured-model conversation.
  7. Use status and evidence to keep repository, installed-host, synthetic, live-backend, recovery, and acceptance claims separate.

Concepts

Configuration

Generated reference

Use Pixel

Extend Pixel

Security and privacy

Operations

Releases and qualification

Contributing and maintenance

Documentation rules

  • Generated pages say how to regenerate them and are checked for drift.
  • Maintained pages identify their audience, document type, feature status, owners, and source-of-truth paths.
  • Current product guides do not copy release versions or provider pins from generated contracts into prose.
  • Historical evidence stays historical. Candidate evidence is not rewritten as Supported or live acceptance.
  • Private paths, credentials, user content, and live evidence do not belong in examples.

See the documentation contract for the enforced metadata and contribution rules.