docs: add Starlight documentation site - #402
Merged
Merged
Conversation
|
Adds a comprehensive documentation site under docs/, built with Astro Starlight and deployed to GitHub Pages. Covers getting started, configuration, usage, storage backends, running as a server, recipes and an API reference, with an API coverage & limitations page. - docs/ as a pnpm workspace package (excluded from biome via biome.json) - GitHub Actions workflow to build and deploy to GitHub Pages - README links to the site - GEO/SEO output: llms.txt, sitemap and full-text search
mvantellingen
force-pushed
the
docs/starlight-documentation-site
branch
from
July 17, 2026 12:16
c08e055 to
98f3f8c
Compare
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.
What
Adds a comprehensive documentation site under
docs/, built with Astro Starlight and deployed to GitHub Pages.Live URL once merged + Pages enabled: https://labd.github.io/commercetools-node-mock/
Contents
runServer) + DockerCommercetoolsMock,ProjectAPI, storage classes, errorsNotes
docs/is a pnpm workspace package; the library'spnpm checkis unaffected (docs/is excluded inbiome.json).llms.txt/llms-full.txt, sitemap, and full-text search.unsafeAdd/getBaseResourcePropertiesare intentionally not documented (to be deprecated).To go live after merge
docsworkflow deploys automatically on pushes tomaintouchingdocs/**.