docs: use-case-first revamp with signing & encryption guides (CPL-357)#573
Open
GTC6244 wants to merge 2 commits into
Open
docs: use-case-first revamp with signing & encryption guides (CPL-357)#573GTC6244 wants to merge 2 commits into
GTC6244 wants to merge 2 commits into
Conversation
…age (CPL-357) Restructure the docs for a first-time developer who knows Lit does signing and encryption/decryption: - Nav (docs.json): Get Started -> use-case guides before any admin content; Management renamed Administration and moved below build content; all existing page URLs unchanged - New pages: concepts.mdx (the five core nouns + permission model), guides/signing.mdx and guides/encryption.mdx (end-to-end journeys with admin references and checklists inline) - Landing page rewritten around the two use-case doors; quickstart hands off to the guides - Verified fixes: imports.mdx memory limit 128->64 MB (matches lit-actions/server/runtime.rs), broken patterns anchor, missing frontmatter on migration/changes.mdx and dashboard.mdx, wrong dashboard URL in migration/changes.mdx, unescaped brace breaking MDX parse of chipotle.mdx Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR revamps the Chipotle developer docs information architecture to be “use-case-first”, guiding new developers toward two primary entry points (signing and encryption/decryption) while keeping existing URLs stable.
Changes:
- Reworks the docs landing + Quick Start flow to funnel readers into the new end-to-end Signing and Encryption & Decryption guides, with a new Core Concepts page for shared terminology.
- Restructures sidebar navigation (Get Started → Use Case guides → deeper references) and renames Management to Administration.
- Applies several doc correctness fixes (anchors, missing frontmatter, dashboard URL, MDX parsing escape, and Lit Actions memory limit reference).
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/index.mdx | Rewrites landing page around signing/encryption “doors” and reorganizes major navigation sections. |
| docs/quickstart.mdx | Adds explicit routing from Quick Start into the two use-case guides + Core Concepts, and refreshes “Next steps”. |
| docs/docs.json | Updates sidebar IA: introduces Get Started + Use Case sections; renames Management → Administration; reorders some groups. |
| docs/concepts.mdx | Adds a Core Concepts page defining accounts, keys, PKPs, actions, and groups with admin links. |
| docs/guides/signing.mdx | Adds an end-to-end signing guide (account → PKP → action signing → local verification → production posture). |
| docs/guides/encryption.mdx | Adds an end-to-end encryption guide (vault PKP → encrypt/decrypt → production lock-down → common pattern). |
| docs/management/dashboard.mdx | Adds missing frontmatter for the Dashboard admin page. |
| docs/lit-actions/migration/changes.mdx | Adds missing frontmatter and corrects Dashboard URL reference. |
| docs/lit-actions/imports.mdx | Fixes a broken patterns anchor and corrects the default memory limit reference to 64 MB. |
| docs/lit-actions/chipotle.mdx | Escapes braces in a generic type example to prevent MDX parsing issues. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+92
to
+95
| import { ethers } from 'ethers'; // v5: ethers.utils.verifyMessage | ||
|
|
||
| const recovered = ethers.utils.verifyMessage('Hello from Lit', signature); | ||
| console.log(recovered === '0xYOUR_PKP_ADDRESS'); // true |
Comment on lines
+56
to
+57
| const result = await client.litAction({ | ||
| apiKey: accountApiKey, |
Comment on lines
+38
to
+39
| const result = await client.litAction({ | ||
| apiKey: accountApiKey, |
Comment on lines
+75
to
+76
| const result = await client.litAction({ | ||
| apiKey: accountApiKey, |
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
…revamp # Conflicts: # docs/docs.json
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.
Restructures the docs around a first-time developer's two entry points — signing and encryption/decryption — per CPL-357. Navigation now leads with Get Started (landing, quickstart, new Core Concepts page) and two new end-to-end guides (
guides/signing.mdx,guides/encryption.mdx) that embed administrative references and checklists at each step, while the Management group is renamed Administration and moved below the build content — with all existing page URLs unchanged. The landing page is rewritten around the two use-case doors and the quickstart hands off to the guides. Also bundles verified fixes: theimports.mdxmemory limit corrected 128→64 MB (matcheslit-actions/server/runtime.rs), a broken patterns anchor, missing frontmatter onmigration/changes.mdxanddashboard.mdx, a wrong dashboard URL, and an unescaped brace that broke MDX parsing ofchipotle.mdx. Validated withmint broken-linksplus a script checking every nav entry, internal link, and heading anchor (remaining warnings are pre-existing indeployment/planning/*.md, which isn't in the nav).🤖 Generated with Claude Code