Repository navigation
docs: a Hosted app section, to install the app, use it, what it keeps and the plans - #22
Merged
Merged
Conversation
… and the plans Four pages written here, since the action has no Markdown about the app, in a sidebar group after the guides, each with its own header picture. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
…ken means no acting as you Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
… approves at once Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A sidebar group, Hosted app, after the guides, with four pages written in this repo. The action has no Markdown about the app, so they are authored
.mdxundersrc/content/docs/hosted-app/, and their ids areHOSTED_APPinsrc/lib/pages.ts.src/lib/routes.tsknows them, sopage()links to them are checked like every other link.The pages and their header pictures
hosted-app/install: Install the appfirst-runhosted-app/using-the-app: Using the appdeploying-3hosted-app/what-the-app-keeps: What the app keeps and never keepsin-synchosted-app/plans: Plans and adopted repospending-5Neighbours in sidebar order: Security (
pending-1) → the four above → sluiceway.yaml (pending-2). No two neighbours share a picture.recordWritersline and what it allows.Nothing here comes from sluiceway/company: no strategy, competitor names, internal numbers, or app decision-record numbers (that repo is private). Everything is in the words of the app's
CONTEXT.md.Sentences that are not product sentences
These give a reason, point outside the product, or depend on something that isn't live yet. Each is worth a look before merging:
app-and-pricing-livebranch. The table follows the numbers given for this change, not the live page.sluiceway.yamlrather than allowed by a setting. It is rationale, and it paraphrases the action's own configuration docs.Changed after review, in
f9b923e: ticking and Rescan from the app are on in production, so the two sentences about a switch are gone. Install the app and Using the app each say instead, in one line, that ticking and Rescan from the app work in a repo whosesluiceway.yamlnamessluiceway[bot]inrecordWriters, and in any other repo they open the dashboard on GitHub. On What the app keeps, the line about a break-in is now a product fact: "The app keeps no token of yours, so it cannot act as you."Added in
801b85b, from the app's second approver slice (#25): Plans says the required second approver is on Team and Team Plus. The customer adds Sluiceway as a custom deployment protection rule on a GitHub environment, which GitHub offers on Enterprise and on public repos only, and on Free the app approves such a job at once. The lead no longer says every feature is on every plan: a plan now also decides whether a second approver can hold a deploy.Checks
bun run checkpasses under the default/docsbase: lint, tokens, pin, typecheck, build, 591 tests.bun run linkspasses: 30715 links on 144 pages all land, under both/docsandDOCS_SITE=https://docs.sluiceway.dev DOCS_BASE=/, withbun testpassing under the second one too.bun run releasewarns that the pin is at v0.42.2 and the action released v0.43.0.Not merged.
🤖 Generated with Claude Code