feat: add a documentation site (Astro + Starlight)#81
Open
OmarAlJarrah wants to merge 21 commits into
Open
Conversation
Starlight's pathWithBase() always prepends the configured base (/kuri) to sidebar link: values, so a link already containing that prefix resolved to /kuri/kuri/api/ instead of /kuri/api/. Only surfaced now that public/api/ has real content to click through to.
1 task
…rce guide This page claimed a flat 80% line-coverage floor, matching the same wrong figure fixed elsewhere in issue #91. The actual per-module Kover verify rules are kuri and kuri-bind at 99% line (85% and 88% branch), and kuri-serde-kotlinx at 90% line / 80% branch.
…alse The comment said a newer push to main supersedes an in-flight deploy rather than queueing behind it, but cancel-in-progress: false right below it does the opposite: the in-flight run keeps going and a newer run in the same pages group waits for it. That's the standard GitHub Pages template setting, chosen deliberately so a production deploy isn't interrupted midway. Reword the comment to describe what actually happens instead of the reverse. Closes #100
This was referenced Jul 19, 2026
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.
Summary
Adds a full documentation site for kuri, built with Astro 7 and Starlight, deployed to GitHub Pages:
docs/SPEC.mdrather than a straight copy./api/, replacing the previous plan to rely on javadoc.io..github/workflows/docs.yml: builds the Dokka reference and the Astro site, then deploys via the GitHub Actions Pages artifact method (no branch ever holds built output). Includes anastro checkgate and an internal link checker.README.mdis trimmed to a concise overview + install snippet, pointing to the new site for everything else.site/is a fully independent bun-managed toolchain — it never touches./gradlew build,ktlintCheck, ordetekt.Manual follow-up required
Before the deploy workflow's first run can succeed, a repo admin needs to set Settings → Pages → Build and deployment → Source to GitHub Actions (not "Deploy from a branch"). This is a one-time console setting; nothing in this PR can change it via the API.
Test plan
cd site && bun install && bun run build— builds all 17 routes (14 guides, landing, spec, plus sitemap/search index)bun run check— passes withpublic/excluded from type-checking (avoids an OOM against Dokka's copied JS assets)./gradlew :kuri:dokkaGeneratePublicationHtml— generates the themed API reference; verified the custom stylesheet is linked in the output.github/workflows/docs.ymlvalidated as well-formed YAML