docs: add NitroSQLite documentation website - #358
Open
chrispader wants to merge 11 commits into
Open
chrispader wants to merge 11 commits into
chrispader wants to merge 11 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
chrispader
added this pull request to stack #367
September 18, 2026 11:42
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.
Nitro SQLite's setup instructions, platform options, and API details currently share one long README. This adds a Fumadocs website with dedicated guides and reference pages, and reduces the README to installation, a small example, and links to the documentation. The site follows VisionCamera's typography and navigation, with an original homepage focused on Nitro's native bindings, Margelo's maintenance, and an interactive database illustration.
The 25 documentation pages start with a Getting Started guide for installation, native setup, rebuilding, and a first query. A Concepts section explains SQLite files and connections, tables and values, queries and indexes, transactions, and operation ordering before the task guides. The guides also introduce each SQLite feature in plain language before showing its Nitro SQLite API. The reference covers the connection methods, global helpers, raw native methods, all exported types, error conversion, and both integration contracts. Examples and caveats were checked against the current TypeScript and native implementations, including the current limitation in column type metadata.
The site lives in
docs/with search, light and dark themes, a sitemap, and a CI workflow. The root Bun workspace includesdocs, so contributors can run its scripts from the repository root. CI and Vercel install the docs workspace with a frozen lockfile; the separate docs lockfile also supports isolated deployment. Margelo's existing Vercel project usesdocs/as its root directory, and the production domain issqlite.margelo.com. Merging this PR will deploy the website frommain.Preview the documentation website with your Margelo Vercel account.