Repository navigation
Update the documentation for Probitas 2.0 - #2
Merged
Merged
Conversation
`client-deno-kv` and `scenario` are still listed in the JSR scope but are no longer part of Probitas, so skip them (before caching, too) instead of documenting packages that cannot be used anymore. Newer Deno releases (2.9 at the time of writing; 2.6 does not) emit `deno doc --json` schema version 2, which nests symbols per module; the site only renders version 1. Fail with a message that names the cause instead of `nodes.find is not a function`. `npm run generate-api` pointed at a non-existent `.js` file; run the TypeScript script with Deno instead. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01N3xvJ1TaozjYSE6eoyo9mq
Generated from the JSR packages that @probitas/probitas 2.0.0 depends on. The Deno KV client, the logger and the old scenario package are gone from Probitas, so their pages are removed. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01N3xvJ1TaozjYSE6eoyo9mq
Probitas 2 runs on Bun and ships as a single binary, so the guides no longer ask for Deno: - Installation covers the binary installer (~/.local/bin), Windows, setup-probitas@v2, the flake's release binary and how to stay on 1.x. - Examples import @probitas-test/probitas and read process.env. - The overview explains editor support (package.json/tsconfig.json from probitas init, @types/node with "types": ["node"]), third-party dependencies, the built-in fmt/lint/check and `cache duckdb`. - The Deno KV client and its expectations are removed. - A migration guide lists what changes from 1.x. - API pages show `npm install @probitas-test/<package>`. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01N3xvJ1TaozjYSE6eoyo9mq
README still described the Deno tasks from before the move to HonoX + Vite, and the agent guides still taught `jsr:` imports and Deno APIs. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01N3xvJ1TaozjYSE6eoyo9mq
Since Probitas 2.0.2 the flake builds the CLI from the locked revision instead of fetching the latest release binary, so `nix flake update` follows main and a release is pinned by its tag. The v2.0.0 and v2.0.1 tags predate that and do not install their own version through Nix. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01N3xvJ1TaozjYSE6eoyo9mq
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.
Summary
install.shinto~/.local/bin,PROBITAS_VERSION/PROBITAS_INSTALL_DIR, supported platforms, no musl, Windows zip), Homebrew,setup-probitas@v2, the Nix flake (release binary; pinv1.0.0for 1.x), and pre-fetching DuckDB for CI.probitas initwrites; new sections on editor support (including@types/nodeand"types": ["node"]), third-party dependencies and runtime APIs;fmt/lint/checkas they work in 2.0; "Native Dependencies" (cache duckdb,PROBITAS_DUCKDB_DIR) in place ofprobitas cache.llms.txt.@probitas-test/probitasimports,process.env, Deno KV removed, new environment variables and.envbehaviour, and the broken/api/scenario/links pointed at/api/probitas/.@probitas/probitas@2.0.0and the package versions it pins; API pages shownpm install @probitas-test/<pkg>.client-deno-kvandscenario(still on JSR, no longer maintained) are excluded.AI.md,README.md,.claude/) updated to match.Why
Probitas 2.0 runs on Bun as a single binary: the site still taught Deno installs,
jsr:imports,Deno.envand the Deno KV client. See MIGRATION.md.Notes
deno doc --jsonschema version 2, which the site cannot render. The script now stops with a clear error on that schema (documented in the README), andnpm run generate-apiruns the.tsscript it actually has. The data here was generated with Deno 2.6.4.Deno.test/Deno.makeTempFileSync/jsr:imports; they come from the packages' sources.mainalready and are left:#stepOptionsin configuration.md (the generated anchor is lowercase) andclient-http#createOidcHttpClientin client.md.deno test -A tests/fails onmainas well (it expectsdist/**/index.md; the Vite build emitsindex.md.html).Test Plan
npm run build(incl. Pagefind)/docs,/AIand/api/<pkg>/#Symbollink and anchor checked against the build and the generated data (only the two pre-existing breakages above remain)fmt --check,lintandlistpass on the in-repo scenarios; the documentedbiome-ignoreexample silences its rule🤖 Generated with Claude Code
https://claude.ai/code/session_01N3xvJ1TaozjYSE6eoyo9mq