Skip to content

Polish the GitHub page: README hero, guides index, community files - #20

Merged
shipmill-romamo[bot] merged 1 commit into
mainfrom
docs/github-page
Oct 8, 2026
Merged

shipmill-romamo[bot] merged 1 commit into
mainfrom
docs/github-page

Conversation

@shipmill-romamo

Copy link
Copy Markdown
Contributor

What and why

The repo page is the first thing pilots and investors see. This brings it in line with common open-source practice.

  • README: logo, badges (CI, PyPI, Python, license, Discussions), the tagline from cloudfall.dev, a Mermaid diagram of the gate, the quickstart moved from line ~140 to the first screen, a guide index table, and a Community section. 394 lines down to about 200
  • No content lost: "Start your own project", "The agent contract", "Inspect servers and audit drift" and "Operations dashboard" moved verbatim to docs/getting-started.md. The Render details are already in the Render migration guide
  • Community files: issue forms (bug, feature, pilot request with a new pilot label), blank issues off with links to Discussions and private security reports, a PR template with the CI checks, .github/SUPPORT.md, and the Contributor Covenant 2.1 (contact conduct@cloudfall.dev)
  • PyPI: the summary matches the repo description, and keywords are added
  • The logo uses an absolute raw URL so it also renders on PyPI

Repo settings changed outside this PR: description, homepage, 16 topics, Discussions on, the empty wiki and Projects off, GitHub Releases backfilled for v0.1.0–v0.5.1.

Checklist

  • uv run pytest passes (363 tests)
  • uv lock --check passes
  • A CHANGELOG.md entry under [Unreleased]
  • Fixtures and docs are synthetic

🤖 Generated with Claude Code

https://claude.ai/code/session_01FS8hJ94DCmHAsqa4LHiywn

The README opens with the pitch, a diagram of the gate, a short quickstart
and a guide index; the long walkthroughs moved verbatim to
docs/getting-started.md. Adds issue forms (bug, feature, pilot request), a
pull request template, SUPPORT.md and the Contributor Covenant 2.1, and
aligns the PyPI summary and keywords with the project's description.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01FS8hJ94DCmHAsqa4LHiywn
@shipmill-romamo
shipmill-romamo Bot merged commit 809bf4d into main Oct 8, 2026
1 check passed
@shipmill-romamo
shipmill-romamo Bot deleted the docs/github-page branch October 8, 2026 09:56
@shipmill-romamo shipmill-romamo Bot added this to the 0.6.0 milestone Oct 8, 2026
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