jwilger/auto_review
1
0
Fork 0
Code Issues 6 Pull requests 1 Releases Packages 1 Activity Actions

Public-facing website for the project #13

New issue
Open
opened 2026-05-01 14:03:16 -07:00 by auto-review · 0 comments
auto-review commented 2026-05-01 14:03:16 -07:00
Collaborator
Copy link

auto_review doesn't have a project website yet. README is the only public surface.

For a self-hostable code-review bot we want:

  • Landing page: 1–2 paragraphs explaining what the bot does, GIF/screencap of a real review on a demo PR, the QUICKSTART command.
  • Operator docs: rendered version of docs/OPERATIONS.md, THREAT-MODEL.md, ADR-*, USER-GUIDE.md. mdBook or similar; built in CI; deployed on every push to main.
  • Demo / sandbox: optional — a hosted gateway against a public test-only Forgejo where prospective adopters can open a PR and watch the bot review it.
  • Release page: links to the release announcement (docs/RELEASE_ANNOUNCEMENT.md) and changelog with anchors.
  • Roadmap & ADR index: surface the design decisions so contributors see the reasoning before proposing changes.

Implementation skeleton:

  • Use mdBook (Rust-native, no JS toolchain) or Zola for static rendering.
  • Source lives in docs/site/ (or a sibling repo).
  • Forgejo Actions workflow: mdbook build → upload to a static host (Cloudflare Pages, Netlify, or a self-hosted bucket).
  • Domain: auto-review.dev or a subdomain of an existing personal domain.
  • License/contributing/CLA docs already exist in-repo; surface them on the site.

Bikeshed-able, but get the static-rendering + auto-deploy pipeline up first; iterate on content.

`auto_review` doesn't have a project website yet. README is the only public surface. For a self-hostable code-review bot we want: - **Landing page**: 1–2 paragraphs explaining what the bot does, GIF/screencap of a real review on a demo PR, the QUICKSTART command. - **Operator docs**: rendered version of `docs/OPERATIONS.md`, `THREAT-MODEL.md`, `ADR-*`, `USER-GUIDE.md`. mdBook or similar; built in CI; deployed on every push to main. - **Demo / sandbox**: optional — a hosted gateway against a public test-only Forgejo where prospective adopters can open a PR and watch the bot review it. - **Release page**: links to the release announcement (`docs/RELEASE_ANNOUNCEMENT.md`) and changelog with anchors. - **Roadmap & ADR index**: surface the design decisions so contributors see the reasoning before proposing changes. **Implementation skeleton:** - Use mdBook (Rust-native, no JS toolchain) or Zola for static rendering. - Source lives in `docs/site/` (or a sibling repo). - Forgejo Actions workflow: `mdbook build` → upload to a static host (Cloudflare Pages, Netlify, or a self-hosted bucket). - Domain: `auto-review.dev` or a subdomain of an existing personal domain. - License/contributing/CLA docs already exist in-repo; surface them on the site. Bikeshed-able, but get the static-rendering + auto-deploy pipeline up first; iterate on content.
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
issue-10-mandatory-sandbox
No results found.
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
jwilger/auto_review#13
No description provided.