Skip to content

docs: compress README public face + add GitHub hygiene files - #14

Merged
maxwellsantoro merged 1 commit into
mainfrom
docs/public-face-compression
Jun 25, 2026
Merged

maxwellsantoro merged 1 commit into
mainfrom
docs/public-face-compression

Conversation

@ramen-implementer

Copy link
Copy Markdown
Contributor

Summary

Public-face polish from a landing-page review: sharpens the 30-second visitor
funnel and adds the GitHub-native contribution surface the repo was missing.
Docs-only — the foundry job is path-scoped and will skip; this PR merges
on org-governance + merge-gate.

README compression

  • Opening identity → "an evidence-gated OS lab for agent-native computing" (was "Rust OS experiment"; leads with the testable, evidence-gated nature instead of the language).
  • New "The Short Version" block after the disclaimer — the compressed bet.
  • Smoke proof promoted to its own "Try the Smallest Proof" section.
  • "Useful help right now" — three tracks (serious systems / newcomer / docs).
  • New secondary "Governance and Research" section (RamenOrg + research, kept parallel, no authority of their own).

New GitHub hygiene files

  • SECURITY.md — private vulnerability reporting, "not production," posture pointers.
  • CODE_OF_CONDUCT.md — Contributor Covenant 2.1.
  • .github/PULL_REQUEST_TEMPLATE.md — evidence level, claim-boundary checklist, separation of duties.
  • .github/ISSUE_TEMPLATE/{bug_report,hardware_evidence_report,docs_confusion}.md — the hardware-evidence template captures claim_path, appliance id, and provenance flags.

Not in this PR

  • Screenshot / asciinema of the boot transcript — needs a recorded session; deferred. The textual "Try the Smallest Proof" block is the hook for now.

Validation

  • git diff --check — clean.
  • just foundry-org-governance-g0 — PASS (status_drift + all 19 metrics).
  • No .rs / .toml / .idl / rust-toolchain changes → foundry skips on CI.

Separation of duties

Opened by ramen-implementer[bot] (A2); awaits approval + merge by a different
identity (A3).

Opening identity becomes "an evidence-gated OS lab for agent-native
computing". Add a compressed "Short Version" and promote the smoke
proof to its own "Try the Smallest Proof" section; restructure
contributor help into three tracks; surface a secondary Governance &
Research section.

Add SECURITY.md (vulnerability reporting + posture), CODE_OF_CONDUCT.md
(Contributor Covenant 2.1), and GitHub issue/PR templates (bug,
hardware-evidence, docs-confusion, pull request) so the public
contribution flow matches the project's evidence discipline.

CHANGELOG + DECISIONS entries. Docs-only: foundry gate skips on CI.

@maxwellsantoro maxwellsantoro left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A3 approval (human, distinct from A2 author app/ramen-implementer). Docs-only public-face polish: README compression (OS-lab identity, Short Version, Try the Smallest Proof, Useful help now, Governance & Research) + 6 GitHub hygiene files (SECURITY.md, CODE_OF_CONDUCT.md, issue/PR templates). Validated: just foundry-org-governance-g0 PASS, git diff --check clean; foundry skipped on CI as docs-only. Separation of duties holds.

@maxwellsantoro
maxwellsantoro merged commit 9d49557 into main Jun 25, 2026
8 checks passed
@maxwellsantoro
maxwellsantoro deleted the docs/public-face-compression branch June 25, 2026 04:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant