-
Notifications
You must be signed in to change notification settings - Fork 986
Docs IA restructure: drill-in sidebar, REST API rename, CLI consolidation, Storage #8154
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
30f950d
docs: vertical drill-in sidebar, Build/Deploy/Manage/Reference IA, RE…
tylerhogarth 9d31023
docs: CLI reference regroup, Storage section, spectrum nav states
tylerhogarth 7aee629
chore: drop formatter-only churn in apps/site
tylerhogarth d05acd4
docs: address PR review findings
tylerhogarth c5a3690
docs: scope sidebar focus handoff to the visible surface
tylerhogarth c2415ef
docs: say "Build an app" on the Get started page
tylerhogarth File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| # AGENTS.md — Prisma docs app | ||
|
|
||
| ## Documentation taxonomy | ||
|
|
||
| Classify every docs page as one of three kinds before writing or moving content: | ||
|
|
||
| 1. **Reference**: interface contracts. CLI commands, flags, REST API endpoints, parameters, config file fields, environment variables, API signatures. | ||
| 2. **Concepts**: platform fundamentals. Projects, workspaces, branching, environment variables as a topic, how things work. | ||
| 3. **Guides**: getting-started and structured step-by-step material. | ||
|
|
||
| ## Placement rules | ||
|
|
||
| 1. Reference material lives under `content/docs/cli/`, `content/docs/rest-api/`, or a section's `---Reference---` meta.json block. Never document flags, parameters, or endpoints in full inside a concept or guide page; link to the reference page instead. | ||
| 2. A product section may keep a thin `cli-reference.mdx` pointer page that links into `cli/v8/*`. `content/docs/compute/cli-reference.mdx` is the canonical example. Full command references live in `cli/v8/`. | ||
| 3. The section is named "REST API" (folder `rest-api`). Do not reintroduce "Management API" in titles, nav, prose, or new URLs. Code identifiers (`@prisma/management-api-sdk`, `createManagementApiClient`) keep their names. | ||
| 4. Sidebar grouping (Build/Deploy/Manage/Reference) is UI config in `src/lib/sidebar-sections.ts`, not content structure. Do not add grouping separators to the root `content/docs/meta.json`. | ||
|
|
||
| ## Moving or renaming pages | ||
|
|
||
| 1. Add a redirect in the live region of `next.config.mjs` `redirects()` (near the `/llms/next.txt` entry). Do not add entries to the commented "Prisma 8 URL cutover" staging blocks unless working on that cutover. Run `pnpm audit:redirects:strict` after. | ||
| 2. Re-run `npx tsx scripts/add-url-frontmatter.ts` after any file move; the required `url:` frontmatter goes stale silently and no linter catches it. | ||
| 3. New top-level sections need an entry in `llmsSections` in `src/lib/llms.ts` (see `.claude/skills/docs-agent-ready`). | ||
| 4. Do not rename the `orm/`, `cli/`, or `guides/` folders or their meta.json titles, and keep `cli/v8/meta.json` title exactly `"v8 (RC)"`: `src/lib/version.ts` path maps and `src/lib/versioned-sidebar-tree.ts` match on those strings and break the version switcher silently. | ||
|
|
||
| ## Generated content | ||
|
|
||
| 1. `content/docs/rest-api/endpoints/` and `public/prisma-rest-api.postman_collection.json` are generated. Never hand-edit; run `pnpm generate:rest-api-docs`. | ||
| 2. The generator prepends redirects to `vercel.json` for endpoints that disappear from the OpenAPI spec; review them after each run. | ||
|
|
||
| ## Validation | ||
|
|
||
| Run from `apps/docs`: | ||
|
|
||
| 1. `pnpm lint:links` — internal links, anchors, `Card` hrefs. It does not check redirect destinations, `version.ts` path maps, `llms.ts` prefixes, or `url:` frontmatter. | ||
| 2. `pnpm audit:redirects:strict` after adding redirects. | ||
| 3. `pnpm lint:agent-ready` after touching sections, llms surfaces, or the OpenAPI explorer. | ||
| 4. `pnpm types:check` and `pnpm build` for code changes. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| AGENTS.md |
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
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
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
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| --- | ||
| title: Global flags | ||
| description: Flags accepted by every command in the unified Prisma CLI. | ||
| url: /cli/v8/global-flags | ||
| metaTitle: Global flags | Prisma 8 CLI | ||
| metaDescription: Reference for the global flags every Prisma 8 CLI command accepts, including output format, log level, prompts, and config path. | ||
| --- | ||
|
|
||
| All commands in the unified Prisma CLI accept these flags. | ||
|
|
||
| | Flag | What it does | | ||
| | --- | --- | | ||
| | `--json` | Print machine-readable output (shorthand for `--format json`). Use this in CI and scripts. | | ||
| | `--format <mode>` | Output format, `human` or `json`. | | ||
| | `--log-level <level>` | Commentary verbosity: `error`, `warn`, `info`, or `verbose`. | | ||
| | `-q`, `--quiet` | Suppress nonessential output (shorthand for `--log-level error`). | | ||
| | `-v`, `--verbose` | Print more detail (shorthand for `--log-level verbose`). | | ||
| | `--color` / `--no-color` | Force colored output on or off. | | ||
| | `--interactive` / `--no-interactive` | Force prompts on or off. | | ||
| | `-y`, `--yes` | Accept prompt defaults without asking. | | ||
| | `--confirm <token>` | Grant a consent prompt non-interactively by typing its token (repeatable). | | ||
| | `--config <path>` | Read this config file instead of `./prisma.config.ts`. | | ||
| | `-h`, `--help` | Print help for a command. | | ||
| | `--version` | Print the CLI version and exit. | | ||
|
|
||
| Use `npx prisma@next <command> --help` when you need the exact command help from the installed version. | ||
|
|
||
| The output modes and the JSON envelope these flags select are documented on [Configuration](/cli/v8/configuration#output-modes). |
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.