Skip to content

Set up the public Made website on GitHub Pages #67

Description

@douglasjarquin

Set up the public Made website on GitHub Pages

Made has no public site. Pinchos and sf2-themes already do: Astro static sites published from main to GitHub Pages.

Give Made the same kind of site: a real landing page people can open.

Related: #29 asked to wire up or remove a docs Astro scaffold (port no-mistakes' Starlight docs, or delete the clutter).
There is no Astro scaffold under docs/ today.
This issue is the decision: ship a public product site like pinchos / sf2-themes, not a no-mistakes docs clone.

Why

A GitHub README is not a site.
Made's pitch is already on the repo ("turn code into green PRs") and in the header image, but there is no public URL to send someone to.
Pinchos and sf2-themes solved that with a small Astro site on GitHub Pages.

Constraints

  • Follow the pinchos / sf2-themes pattern: Astro, static output, GitHub Pages project site, deploy from main with GitHub Actions.
  • Live URL is https://douglasjarquin.github.io/made/ with base: '/made'.
  • Put the site in site/.
    Keep docs/ as the in-repo markdown that agents already read.
  • Do not port no-mistakes' Starlight docs/ site.
    That is a different product and a different information architecture.
  • Do not copy pinchos or sf2-themes branding.
    Made already has a GitHub header image; use this project's own voice and that art.
  • Do not turn this into a full documentation portal.
    v1 is a landing page plus a getting-started page that matches how someone actually installs and runs made.
  • Pages is not enabled on this repo today (the Pages API 404s).
    Enabling GitHub Pages with source GitHub Actions is part of done.
  • The PR that ships this must Closes #<this-issue>.
    If Wire up or remove the docs Astro scaffold #29 is still open when this lands, close Wire up or remove the docs Astro scaffold #29 as completed-by-this or not planned, with a comment pointing here.

v1 pages

  • /made/ landing: what Made is, how it relates to no-mistakes / consigliere / herdr, GitHub CTA.
  • /made/start/ (or /install/): install and the first useful commands (made doctor, made verify, made cursor) from the README, not a paraphrase that will drift.

Optional later, not this issue: command reference, changelog, llms.txt.

Acceptance

  • Astro static site lives in site/ with base: '/made' and a site origin of https://douglasjarquin.github.io (or the pinchos form that includes the path).
  • Landing and getting-started pages are real product pages.
  • In-repo markdown under docs/ stays the agent/docs source of truth and is not replaced by Starlight.
  • mise (or existing repo) tasks can install, dev-serve, and build the site from the repo root.
  • A GitHub Actions workflow builds the site on PRs that touch it, and deploys to GitHub Pages only from main.
  • GitHub Pages is set to GitHub Actions and https://douglasjarquin.github.io/made/ serves the landing page.
  • README links the live site.
  • PR uses Closes #<this-issue>.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions