Repository navigation
docs: rebuild the documentation website with Astro Starlight - #395
Merged
Merged
Conversation
Replace the React 16 / webpack 3 site with an Astro Starlight site for react-simple-chatbot 1.0. - Source in website/, built site in the branch root (served by GitHub Pages); `npm run publish-site` rebuilds it - Pages: getting started, guides, live examples, playground, API reference, FAQ, changelog and contributing - Live examples render the same file shown as their code - Playground with live preview, templates and share links - Search, dark mode, llms.txt, sitemap, link validation, Open Graph image - Old hash URLs (/#/docs/...) redirect to the new pages - Removes the share buttons and the dead Google Analytics - Site workflow type-checks, builds and checks the committed site
A build on Linux is not byte-identical to a build on macOS, so the pull request check no longer compares the committed root. Instead, the workflow rebuilds the root after a merge into gh-pages and commits it.
5 of 10 tasks
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.
Description
Rebuilds the documentation website (https://lucasbassetti.github.io/react-simple-chatbot/) for react-simple-chatbot 1.0. The old site was a React 16 / webpack 3 app that no longer built, with outdated content, broken share buttons and a dead Google Analytics tag. The new one uses Astro Starlight.
What's new
llms.txt, sitemap, Open Graph image, mobile layout./#/docs/installation...) redirect to the new pages.How the branch works
GitHub Pages keeps serving this branch as it is, so no settings change is needed:
website/: the source (pages inwebsite/src/content/docs, examples inwebsite/src/examples)..nojekyllmakes Pages serve the_astro/folder.website/(npm run publish-siterebuilds the root locally when needed).Where to start reviewing
website/astro.config.mjs: site config, sidebar, legacy redirects.website/src/components/:Demo.astro+ExampleRenderer.tsx(live examples),Hero.astro+HeroChat.tsx(home),Playground.tsx.website/src/content/docs/: the pages.README.mdandwebsite/scripts/publish.mjs: how to develop and publish.The root changes (
_astro/,pagefind/,*/index.html...) are generated.Related issue
None.
Type of change
feat: new featurefix: bug fixdocs: documentationrefactor/perf/testbuild/ci/chore!, and the migration is described below)How has this been tested?
The built root was served locally at
/react-simple-chatbot/, like GitHub Pages does:astro checkA floating demo inside the page was covered by the sidebars (the Starlight content is an isolated stacking context), so floating examples render in
document.body.Breaking changes
None for the library. Old site URLs redirect; the only removed page is "Donate".
Checklist
npm run checkandnpm run buildpass