Skip to content

docs: getting started leads with the GitHub App, and running the action yourself is its own page - #25

Merged
robbeverhelst merged 1 commit into
mainfrom
app-first
Sep 26, 2026
Merged

robbeverhelst merged 1 commit into
mainfrom
app-first

Conversation

@robbeverhelst

Copy link
Copy Markdown
Contributor

Follows the decision that the app is the way in and the action is the path you run yourself.

  • Get started (/get-started/) now installs the GitHub App: the onboarding pull request adds the workflow and a starter sluiceway.yaml, the console at console.sluiceway.dev guides the rest, free for 5 repos. Every deploy still runs in your own GitHub Actions with your credentials.
  • Run the action yourself (/get-started/run-the-action-yourself/): the former Get started, whole (Requirements and the steps, read from the action's README), with a short intro that says it is the same deploys with the issue as the only dashboard.
  • How the app and the action work together (/get-started/the-app-and-the-action/): the webhook tick within about a second, judged with the action's own code; the action's resolve as the fallback (about 20 seconds, still deploys when the app is down); where deploys run and who holds credentials; recordWriters: ["sluiceway[bot]"] for ticks from the console and the command line.
  • Sidebar: Start now lists Get started, Run the action yourself, The app and the action. Landing cards and the install page link the new pages.
  • /get-started/#requirements and #get-started redirect to the new page. The app pages link console.sluiceway.dev (app.sluiceway.dev 301s there).
  • The reference is unchanged.

bun run check and bun run links pass locally.

🤖 Generated with Claude Code

…self is its own page

Get started now installs the GitHub App: the onboarding pull request adds the workflow and a
starter sluiceway.yaml, and the console guides the rest. The steps without the app move, whole,
to get-started/run-the-action-yourself, and a new page says how the app and the action work
together: the webhook tick, the action's resolve as the fallback, where deploys run and who
holds credentials. Old get-started fragments go on to the new page. The app pages link
console.sluiceway.dev, where app.sluiceway.dev now redirects.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@robbeverhelst
robbeverhelst merged commit effa0f2 into main Sep 26, 2026
4 checks passed
@robbeverhelst
robbeverhelst deleted the app-first branch September 26, 2026 10:37
robbeverhelst added a commit that referenced this pull request Sep 27, 2026
)

The header takes the landing page's shape (sluiceway/landing #25): Go to
console, linking https://console.sluiceway.dev, is the one thing in the bar
that looks pressable. The Docs repo and GitHub text links become one small
quiet GitHub mark (Octicons mark-github-16, aria-label "Sluiceway on
GitHub") without an outline or shadow. The theme switch loses its outline
and shadow, and search and the phone menu button their shadow.

A Header override puts the button beside search below 50rem, so it stays
in the bar on a phone, and in the right group from there. Below 500px the
wordmark is read out but not shown, so everything fits at 320px. Between
50rem and 60rem search is its icon, so the theme switch is not cut off.
The menu button is sized through --sl-menu-button-size, so it sits
level with the rest of the bar.

Co-authored-by: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
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