Add an Astro + Starlight documentation site#4
Merged
Merged
Conversation
Closes #3. Port the documentation system used by the sibling project to goway: Astro with Starlight and the Ion theme, recolored with the monochrome palette. - docs/ now holds the full site: astro.config.mjs with the goway navigation sidebar, package.json, tsconfig.json, src/content.config.ts, src/styles/theme.css, the shared assets, and a .vscode recommendation file. - src/content/docs/ contains goway-specific content: an introduction splash, a getting-started tutorial, six guides (writing migrations, running migrations, configuration, callbacks, dialects, command line), an eight-page reference (configuration, commands, migration naming, schema history, placeholders, callbacks, dialects, CLI), and a four-recipe cookbook (embedding migrations, programmatic setup, non-transactional migrations, baselining an existing database). - The existing design.md is kept alongside the site sources. The site builds cleanly with pnpm build (23 pages, no broken links). Build artifacts (node_modules, dist, .astro) are git-ignored.
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.
Closes #3.
Ports the documentation system from the sibling project (gooq) to goway and replaces all content with goway-specific documentation.
Toolchain (mirrored)
Astro + Starlight with
starlight-ion-themeand the monochrome palette insrc/styles/theme.css. Sameastro.config.mjs/package.json/tsconfig.json/content.config.tslayout and the shared SQL-file artwork.Content (rewritten for goway)
Every page was authored against the real source (accurate signatures, defaults, states, flags); all internal links validated against actual routes (0 broken).
Verification
pnpm install+pnpm buildsucceeds: 23 pages, no broken links. Build artifacts (node_modules,dist,.astro) are git-ignored. The existingdocs/design.mdis kept.