docs: overhaul README, AGENTS, docs IA, and consumer skills - #68
Closed
martijn00 wants to merge 37 commits into
Closed
docs: overhaul README, AGENTS, docs IA, and consumer skills#68martijn00 wants to merge 37 commits into
martijn00 wants to merge 37 commits into
Conversation
Develop the library on TypeScript 7 while keeping the consumer peer at 5.9–7, and pin shared toolchain versions through a strict pnpm catalog so CI and local installs stay aligned. Co-authored-by: Cursor <cursoragent@cursor.com>
Give each factory its own provider/hook/Check bindings so nested policies do not share state, and hydrate dehydrated rules on the first client render without mutating during render. Co-authored-by: Cursor <cursoragent@cursor.com>
Cache one initialized instance per RSC request so concurrent server callers share setup, and keep layouts synchronous with permission work behind Suspense for Cache Components. Co-authored-by: Cursor <cursoragent@cursor.com>
Subscribe to setup/ready during render instead of after an effect so dehydrated booleans and already-initialized rules are visible on the first paint. Co-authored-by: Cursor <cursoragent@cursor.com>
Toolchain skills from skills.sh fail format check and are not project source. Co-authored-by: Cursor <cursoragent@cursor.com>
Oxfmt rejected the barrel and type-test files, and pinning React 18 in the catalog conflicts with docs/fumadocs React 19 peers. Co-authored-by: Cursor <cursoragent@cursor.com>
Oxfmt requires a single trailing newline after the merge from the React factory branch. Co-authored-by: Cursor <cursoragent@cursor.com>
Reconstruct published npm history, show it on the docs site, and wire conventional-commit releases. Co-authored-by: Cursor <cursoragent@cursor.com>
Upgrade Fumadocs to 16.15 with the Base UI alias. Ignore .agents and .claude so CI format check skips third-party skill files. Co-authored-by: Cursor <cursoragent@cursor.com>
pnpm 11 rejects packages newer than one day in frozen CI installs. Co-authored-by: Cursor <cursoragent@cursor.com>
Wire Permix into Nest via APP_GUARD so each request gets its own instance, then enforce @check on handlers without tying the API to Express middleware. Closes letstri#11. Co-authored-by: Cursor <cursoragent@cursor.com>
Store one Permix instance per Nitro event so Nuxt server routes and Vue SSR share rules without leaking state across requests. Co-authored-by: Cursor <cursoragent@cursor.com>
Store a per-request Permix instance on Astro locals so middleware, endpoints, and pages can share rules without tying UI islands to a new client adapter. Co-authored-by: Cursor <cursoragent@cursor.com>
React Router 7 (including Remix) needs a per-request instance on middleware context so loaders can dehydrate into permix/react. Co-authored-by: Cursor <cursoragent@cursor.com>
Reuse existing Zod, Valibot, or ArkType schemas on action specs and via permix/standard-schema so ReBAC callbacks stay typed without duplicate interfaces. check() still does not parse data at runtime. Co-authored-by: Cursor <cursoragent@cursor.com>
Parse check() data with the entity schema when validate is deny or throw, and lock Zod, Valibot, ArkType, and Effect Schema behind regression tests so those integrations stay working. Co-authored-by: Cursor <cursoragent@cursor.com>
…talog-extraction Co-authored-by: Cursor <cursoragent@cursor.com>
…talog-extraction Co-authored-by: Cursor <cursoragent@cursor.com>
…talog-extraction Co-authored-by: Cursor <cursoragent@cursor.com>
…talog-extraction Co-authored-by: Cursor <cursoragent@cursor.com>
…talog-extraction Co-authored-by: Cursor <cursoragent@cursor.com>
…talog-extraction Co-authored-by: Cursor <cursoragent@cursor.com>
Avoid passing undefined React Router params. Narrow the generated Svelte component at its factory boundary so TypeScript 7 checks remain valid. Co-authored-by: Cursor <cursoragent@cursor.com>
Derive typed definitions and metadata from static permission markers so application usage becomes the catalog source of truth. Include CLI, watch and check workflows, Next.js integration, typed payload overlays, provider coverage validation, and consumer guidance. Co-authored-by: Cursor <cursoragent@cursor.com>
Centralize per-invocation authentication, rule resolution, typed decisions, dehydration, and catalog coverage for isolated provider integrations. Co-authored-by: Cursor <cursoragent@cursor.com>
Provide an isolated Fetch handler, deterministic OpenAPI contract, and typed client for caller-scoped and trusted service authorization checks. Co-authored-by: Cursor <cursoragent@cursor.com>
Add verified claims and user adapters, generated Database type inference, typed policy manifests, and secure RLS recipes for Supabase applications. Co-authored-by: Cursor <cursoragent@cursor.com>
Provide isolated server and client plugins, typed request helpers, and optional access-control inference without shared mutable rule state. Co-authored-by: Cursor <cursoragent@cursor.com>
Provide isolated Auth and request resolution, explicit permission mappings, bearer-token permissions transport, and a thin Next.js convenience layer. Co-authored-by: Cursor <cursoragent@cursor.com>
Resolve authenticated identities and isolated rules before Convex handlers, while preserving function validators and generated data-model inference. Co-authored-by: Cursor <cursoragent@cursor.com>
Add a credential-free acceptance example. Align consumer skills with the stable adapter APIs. Co-authored-by: Cursor <cursoragent@cursor.com>
Verify the installed tarball and execute RLS boundaries against local Supabase. Co-authored-by: Cursor <cursoragent@cursor.com>
Restructure consumer skills around invariants and per-adapter references, and add the missing conceptual docs so the public surface matches the full adapter stack. Co-authored-by: Cursor <cursoragent@cursor.com>
|
@martijn00 is attempting to deploy a commit to the letstri Team on Vercel. A member of the Team first needs to authorize it. |
Owner
|
Closing: documents the provider/extractor API stack that's being closed. |
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
2 participants
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
Rewrites the public docs, README, maintainer
AGENTS.md, and consumer skills so they match the full adapter stack on #66 (frameworks, extraction, providers).Consumer skills now follow an architecture-skill workflow: one always-loaded
SKILL.md(invariants, ordered steps, verify checklist) plus short per-adapter references instead of lumpedfrontend.md/providers.md.Docs add the missing conceptual layer (concepts, security, adapter chooser, cookbook, examples index) and regroup the sidebar into Getting Started / Guide / Cookbook / UI / Full-stack / HTTP / RPC / Data / Providers.
Depends on #66. Until that prerequisite merges, GitHub includes its stacked commits in this diff; afterward this PR narrows to the documentation commit.
Testing
pnpm format:check(via pre-commit)pnpm lint(via pre-commit)pnpm check-types(via pre-commit)pnpm test(via pre-commit)pnpm --filter permix run skills:validatepnpm --filter permix run skills:stalepnpm --filter docs run check-typescd docs && pnpm dev) — blocked by a pre-existing Twoslash + TypeScript 7readFile500 on this stack when loadingguide/check.mdx. Sidebar grouping is encoded indocs/content/docs/meta.json; every adapter card on quick-start has a matching MDX page.Checklist
docs/content/docs/,README.md)permix/skills/aligned with public integration patternsMade with Cursor