Repository navigation
feat(docs): publish the docs site from this repository at /refract/ - #41
Merged
Merged
Conversation
The site was built and deployed by the refract-docs repository at https://refract-org.github.io/refract-docs/, so since #37 an edit to apps/docs published nowhere. docs-deploy.yml now builds apps/docs on pushes to main and publishes it to this repository's Pages site, https://refract-org.github.io/refract/. build.mjs's BASE and SITE_URL default to the new address, so canonical URLs, og:url, JSON-LD and the sitemap use it; the docs tests expect it. docs.js's fallback base pointed at /refract-docs/ and is updated with it. The README, CONTRIBUTING, ARCHITECTURE, package READMEs, apps' READMEs and the "Full docs" line `refract analyze` prints point at the new site. The old address keeps working through a redirect-only site published from refract-docs, in a separate PR there. 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
1 participant
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.
Stacked on #40. Once #40 merges, GitHub retargets this PR to
main.Since #37,
apps/docshas been the docs site's source, but the site still deployed from therefract-docsrepository, so an edit here published nowhere. This moves deployment here. It's step 1 ofdocs/repositories.md, using the "deploy from refract, redirect the old URLs" option.What changes
docs-deploy.ymlbuildsapps/docson pushes tomainthat touch it, or when run by hand, and publishes the result to this repository's Pages site at https://refract-org.github.io/refract/.build.mjs:BASEandSITE_URLnow default to/refract/, so canonical URLs,og:url, JSON-LD and the sitemap use the new address. The docs tests expect it too.assets/docs.jsfell back to/refract-docs/, and since the build never setsREFRACT_BASE, that fallback was the value always used. It now falls back to/refract/.refract analyzeprints now point at the new site. The package READMEs' "Docs" links used to point at therefract-docsGitHub repo.Old URLs
refract-org/refract-docs#34 turns the old site into redirects:
/refract/, keeping the query string and#fragment404.htmlsends any other old path to the same path under/refract/All 53 old pages exist in this build.
Verified locally
/refract/. All 59 internal links on the home page resolve under/refract/, the stylesheet and search index load, and searching for "citation" returns results.build,biome ci packages/,typecheck,test(408 passed) andcheck:examplespass.apps/docs: lint, tests (103) and build pass.Cutover order
🤖 Generated with Claude Code