Repository navigation
New documentation site: Astro + Starlight, indigo theme, new icon - #8
Merged
Merged
Conversation
…nerability reporting.
This was referenced Nov 15, 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
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.
Replaces the Jekyll site with an Astro + Starlight documentation site for jsondb-core 1.1.16. It adds the new indigo theme, a redesigned icon, a Build-and-deploy workflow, and Dependabot. Part of Jsondb/jsondb-core#80.
Design and plan:
docs/superpowers/specs/2026-11-16-website-overhaul-design.mdanddocs/superpowers/plans/2026-11-16-website-overhaul.md.Where to look
Review closely
src/content/docs/guides/*.md— technical accuracy against 1.1.16. Check most closelyschema-versions.md(you must open withcompatibilityMode = true),find-and-modify.md(the conversion table),crud.md(which operation fails when), andencryption.md(key handling advice)..github/workflows/deploy.yml—buildruns on every PR;deployruns only on push tomaster, withpages: write/id-token: writescoped to that job.astro.config.mjs— the sidebar, the head tags (favicons,og:image), and the edit-link base…/edit/master/.src/content/docs/reference/upgrading.mdandsecurity.md— claims about 1.0.x → 1.1.x behaviour changes and how to report vulnerabilities.Skim
src/content/docs/index.mdx,src/components/*.astro,src/styles/theme.css— the landing page and theme.src/content/docs/start/*,reference/xpath-cheatsheet.md.scripts/build-icons.mjs,src/assets/logo*.svg..github/dependabot.yml— npm and github-actions, weekly, each grouped into one PR.Safe to skip
public/*.png,public/favicon.ico— generated bynpm run icons.package-lock.json.docs/superpowers/*— the spec and plan; Astro ignores them._posts/,_includes/,Gemfile*,img/, …).How it was checked
io.jsondb:jsondb-core:1.1.16from Maven Central, in a scratch project (not committed) compiled with--release 8: 112 assertions, all passing. Each one checks a claim the docs make, including every query in the cheat sheet, every slice in the slicing table, every row of the conversion table, and the backup path rules. This caught several things the docs now state correctly:insert/save/upsert/removethrows a bareNullPointerException;compatibilityModeis on;npm ci && npm run buildpasses, andstarlight-links-validatorreports all internal links valid, anchors included.npm audit: 0 vulnerabilities. The 63 Dependabot alerts GitHub reports onmasterall come from the oldGemfile.lock, which this PR deletes.What this does not do
LICENSE.txtis deleted, with nothing replacing it. It was the MIT licence of the old theme (© 2014 Tim O'Brien), which this PR removes.setSyncFolderOnWrite. A few pages warn about 1.1.16 behaviour that's fixed onmaster; update them when the next release ships.master: thebuildcheck is required, it needs 1 approval with a FarooqKhan bypass, and admins are included.