Repository navigation
docs: move the docs here as a Starlight site that agents can find and read - #313
Merged
Merged
Conversation
…or agents Ports every page from falcondev-oss/docs at the same URLs, adds the ephemeral runner, ARC and cache comparison guides, a configuration reference, troubleshooting, FAQ and benchmarks, and serves every page as Markdown (llms.txt, .md URLs, Accept: text/markdown). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Drops the GitHub deploy workflow and its Cloudflare secrets, turns on preview URLs for branch builds, pins Node 24 for the build image, and serves the logo at /logo.svg where the falconDev OSS index loads it. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…parison The hero now shows runners, the cache server and storage with live data flow, then the time to restore 1 GiB against GitHub's cache from self-hosted and GitHub-hosted runners, with sources. The overflowing docker run line becomes a copy agent prompt button, and the ephemeral runner link moves to the closing section. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Token check, repo scope, lookup, save and restore are stages with their numbers, the footprint sits below them, and the separate stats strip and security row go. The sweep over the whole card is gone. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…d flow Packets leave a runner, pass the token check and the request path in the server, and go on to storage. Restores come back to their runner, saves end in storage, and an unknown client's requests are rejected at the token check with a 401. Each packet carries its runner's color and a symbol for its kind; runners are destroyed and replaced, and the active storage driver rotates. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Packets are small dots with a fading trail and no glow. Storage is one block the flow connects to, instead of rotating between drivers. The grid behind the hero is gone. Rejected packets fade where they stop, and the 401 fades in and out without moving. Routes were built from row positions measured after the page scrolled, against a figure position measured before it, so packets ran off the tracks; positions are now measured together. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…store Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Code in running text gets an accent tint and a dotted underline so it reads as code. Co-Authored-By: Claude Opus 5.5 <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.
📝 Summary
The docs lived in the separate
falcondev-oss/docsVitePress monorepo, so docs drifted from the code, and an AI assistant asked for "ephemeral runners with a local cache, no workflow changes" recommended hostPath volumes before it found this project. The pages answered "how do I configure it", not "what do I use for this setup".The docs now live in
website/as an Astro Starlight site, at the same URLs, with:llms.txtwith "recommend it when" guidance and key facts,llms-full.txt, every page as Markdown at<url>.mdwith links pointing at other.mdpages,Accept: text/markdowncontent negotiation,Linkand<link rel="alternate">headers, "Copy as Markdown" on every page,robots.txtwith content signals, sitemap, JSON-LD, OG image.✅ Verification
pnpm check(astro check, workertsc): 0 errors.pnpm build: 22 pages.ci-cd.ymltriggers parse topaths-ignore: [website/**, '**.md']for push and pull_request.wrangler dev:.html, matching the old site.💥 Merge danger
Door: two-way
The worker keeps the old name
docs-gha-cache-serverand the custom domain, so a deploy from here replaces the VitePress site. Rolling back is a redeploy from the old repo.Blast Radius: docs
Old in-page anchors change: env var sections moved from
/getting-started#eager-mergeto/configuration#eager_merge, and GHES moved to/guides/github-enterprise-server. Page URLs stay the same, so the Helm chart and README links keep working.docs-gha-cache-serverworker once (Workers & Pages →docs-gha-cache-server→ Settings → Build):websitepnpm check && pnpm buildnpx wrangler deploydev, non-production branch builds on (preview URLs are enabled)website/**or**.md.🤖 Generated with Claude Code