added mintlify docs #17
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2023 Mintlify | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
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,43 @@ | ||
| # Mintlify Starter Kit | ||
|
|
||
| Use the starter kit to get your docs deployed and ready to customize. | ||
|
|
||
| Click the green **Use this template** button at the top of this repo to copy the Mintlify starter kit. The starter kit contains examples with | ||
|
|
||
| - Guide pages | ||
| - Navigation | ||
| - Customizations | ||
| - API reference pages | ||
| - Use of popular components | ||
|
|
||
| **[Follow the full quickstart guide](https://starter.mintlify.com/quickstart)** | ||
|
|
||
| ## Development | ||
|
|
||
| Install the [Mintlify CLI](https://www.npmjs.com/package/mint) to preview your documentation changes locally. To install, use the following command: | ||
|
|
||
| ``` | ||
| npm i -g mint | ||
| ``` | ||
|
|
||
| Run the following command at the root of your documentation, where your `docs.json` is located: | ||
|
|
||
| ``` | ||
| mint dev | ||
| ``` | ||
|
Comment on lines
+25
to
+27
Contributor
There was a problem hiding this comment. 🧹 Nitpick | 🔵 Trivial Add language specifier to fenced code block. Line 25 code block should declare bash language for syntax highlighting. -```
+```bash
mint dev
-```
+```🧰 Tools🪛 markdownlint-cli2 (0.18.1)25-25: Fenced code blocks should have a language specified (MD040, fenced-code-language) 🤖 Prompt for AI Agents |
||
|
|
||
| View your local preview at `http://localhost:3000`. | ||
|
|
||
| ## Publishing changes | ||
|
|
||
| Install our GitHub app from your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app) to propagate changes from your repo to your deployment. Changes are deployed to production automatically after pushing to the default branch. | ||
|
|
||
| ## Need help? | ||
|
|
||
| ### Troubleshooting | ||
|
|
||
| - If your dev environment isn't running: Run `mint update` to ensure you have the most recent version of the CLI. | ||
| - If a page loads as a 404: Make sure you are running in a folder with a valid `docs.json`. | ||
|
|
||
| ### Resources | ||
| - [Mintlify documentation](https://mintlify.com/docs) | ||
|
Comment on lines
+42
to
+43
Contributor
There was a problem hiding this comment. 🧹 Nitpick | 🔵 Trivial Add blank line before heading. Markdown heading at line 42 needs a blank line above it for consistency with MDX standards. - If a page loads as a 404: Make sure you are running in a folder with a valid `docs.json`.
+
### Resources
🧰 Tools🪛 markdownlint-cli2 (0.18.1)42-42: Headings should be surrounded by blank lines (MD022, blanks-around-headings) 🤖 Prompt for AI Agents |
||
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,4 @@ | ||||||||||||||||||
| --- | ||||||||||||||||||
| title: Client Library | ||||||||||||||||||
| description: Overview to Rust and Typescript client guides. Guides include step-by-step implementation and full code examples. | ||||||||||||||||||
| --- | ||||||||||||||||||
|
Comment on lines
+1
to
+4
Contributor
There was a problem hiding this comment. 🧩 Analysis chainFile content appears incomplete—no body after front matter. The front matter promises "Rust and Typescript client guides" with "step-by-step implementation and full code examples," but the file contains no body content at all. This creates a disconnect between the metadata and the actual page structure. Verify whether:
Typo in description: "Typescript" should be "TypeScript" (capital S) to match standard naming conventions and consistency with the broader tech community. Apply this diff to fix the capitalization: -description: Overview to Rust and Typescript client guides. Guides include step-by-step implementation and full code examples.
+description: Overview to Rust and TypeScript client guides. Guides include step-by-step implementation and full code examples.🏁 Script executed: #!/bin/bash
# Inspect the actual file content to verify state
echo "=== File Content ==="
cat zk-compression-docs/mintlify-docs/compressed-pdas/client-library.mdx
echo -e "\n=== File Stats ==="
wc -l zk-compression-docs/mintlify-docs/compressed-pdas/client-library.mdx
echo -e "\n=== Directory Listing ==="
fd --type f . zk-compression-docs/mintlify-docs/compressed-pdas/ | head -20
echo -e "\n=== TypeScript vs Typescript Usage in Docs ==="
rg -n "ypeScript" zk-compression-docs/mintlify-docs/ | head -15Length of output: 529 🏁 Script executed: #!/bin/bash
# Check repository structure and locate documentation
echo "=== Repository Root Contents ==="
ls -la | head -20
echo -e "\n=== Search for zk-compression-docs Directory ==="
find . -maxdepth 2 -name "*zk-compression*" -o -name "*docs*" -type d 2>/dev/null | head -10
echo -e "\n=== Find All .mdx Files ==="
fd -e mdx | head -20
echo -e "\n=== Check for compressed-pdas Directory ==="
fd "compressed-pdas" -type dLength of output: 2702 🏁 Script executed: #!/bin/bash
# Properly inspect the file content
echo "=== File Content ==="
cat "zk-compression-docs/mintlify-docs/compressed-pdas/client-library.mdx"
echo -e "\n=== File Line Count ==="
wc -l "zk-compression-docs/mintlify-docs/compressed-pdas/client-library.mdx"
echo -e "\n=== Check TypeScript Naming in Docs ==="
rg -n "TypeScript|Typescript" zk-compression-docs/mintlify-docs --type mdx | head -20
echo -e "\n=== Inspect Similar Index Files ==="
cat "zk-compression-docs/mintlify-docs/compressed-pdas/guides.mdx"Length of output: 3269 🏁 Script executed: #!/bin/bash
# Search for TypeScript naming across entire codebase
echo "=== TypeScript vs Typescript in Codebase ==="
rg -n "TypeScript|Typescript" zk-compression-docs/ | head -30
echo -e "\n=== Check Rust references for pattern ==="
rg -n "Rust and" zk-compression-docs/mintlify-docs --max-count 5Length of output: 12263 File missing promised body content—description incompleteness. The front matter describes "Rust and Typescript client guides" with "step-by-step implementation and full code examples," but the file contains only YAML metadata with zero body content. Compare this to
Fix TypeScript capitalization: The description uses "Typescript" but the standard throughout the codebase is "TypeScript" (capital S). Lines 3 in client-development.mdx and multiple other files use the proper capitalization. -description: Overview to Rust and Typescript client guides. Guides include step-by-step implementation and full code examples.
+description: Overview to Rust and TypeScript client guides. Guides include step-by-step implementation and full code examples.📝 Committable suggestion
Suggested change
🧰 Tools🪛 LanguageTool[grammar] ~1-~1: Hier könnte ein Fehler sein. (QB_NEW_DE) |
||||||||||||||||||
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,204 @@ | ||||||
| --- | ||||||
| title: Create a Program with Compressed PDAs | ||||||
| description: Overview to compressed PDA core features and guide for program development | ||||||
| --- | ||||||
|
|
||||||
| Compressed PDAs provide full functionality of accounts at PDAs, without per-account rent cost. | ||||||
|
|
||||||
| | Creation | Regular PDA Account | Compressed PDA | Cost Reduction | | ||||||
| | :------------- | :--------------------- | :---------------------- | :------------------ | | ||||||
| | 100-byte PDA | ~ 0.0016 SOL | **~ 0.00001 SOL** | ***160x*** | | ||||||
|
|
||||||
| Compressed PDAs are derived using a specific program address and seed, like regular PDAs. Custom programs invoke the [Light System program](#user-content-fn-1)[^1] to create and update accounts, instead of the System program. | ||||||
|
|
||||||
| #### Compressed PDAs at a Glance | ||||||
|
|
||||||
| <CardGroup cols={3}> | ||||||
| <Card title="Rent free PDAs"> | ||||||
| Create accounts at program-derived addresses without upfront rent exempt balance. | ||||||
| </Card> | ||||||
| <Card title="Full PDA Functionality"> | ||||||
| Persistent unique identification and program ownership. | ||||||
| </Card> | ||||||
| <Card title="Composable"> | ||||||
| CPI support between compressed and regular PDAs. | ||||||
| </Card> | ||||||
| </CardGroup> | ||||||
|
|
||||||
| ## Start Building | ||||||
|
|
||||||
| Developing with compressed PDAs works similar to regular PDAs and involves minimal setup: | ||||||
|
|
||||||
| ### Prerequisites | ||||||
|
|
||||||
| <Info> | ||||||
| Required versions: | ||||||
|
|
||||||
| * **Rust**: 1.86.0 or later | ||||||
| * **Solana CLI**: 2.2.15 | ||||||
| * **Anchor CLI**: 0.31.1 | ||||||
| * **Zk compression CLI**: 0.27.0 or later | ||||||
| * **Node.js**: 23.5.0 or later | ||||||
|
Comment on lines
+37
to
+41
Contributor
There was a problem hiding this comment. 🧩 Analysis chainVerify version requirements are current and compatible. The documentation specifies exact version requirements for the development environment:
Ensure these versions are:
🏁 Script executed: #!/bin/bash
# Description: Check version availability and compatibility
# Check Solana CLI latest release
echo "Solana CLI latest releases:"
curl -s https://api.github.com/repos/solana-labs/solana/releases | jq -r '.[0:3] | .[] | .tag_name' | head -5
# Check Anchor CLI latest version
echo -e "\nAnchor CLI latest version info:"
npm view @project-serum/anchor version 2>/dev/null || echo "Check manually on npm"
# Check Light Protocol CLI versions
echo -e "\nLight Protocol CLI versions:"
npm view @lightprotocol/zk-compression-cli versions --json | jq -r '.[-5:]'Length of output: 211 Update version requirements to reflect current stable tooling releases. The documented versions are significantly outdated:
Update the version matrix to match current ecosystem standards. Consider whether to pin 0.31.1 or upgrade to the latest Anchor 0.32.1 for better compatibility with current Solana tooling. |
||||||
| </Info> | ||||||
|
|
||||||
| **Install Solana CLI:** | ||||||
|
|
||||||
| ```bash | ||||||
| sh -c "$(curl -sSfL https://release.solana.com/v2.2.15/install)" | ||||||
| ``` | ||||||
|
|
||||||
| **Install Anchor CLI:** | ||||||
|
|
||||||
| ```bash | ||||||
| cargo install --git https://github.com/coral-xyz/anchor avm --force | ||||||
| avm install latest | ||||||
| avm use latest | ||||||
| ``` | ||||||
|
|
||||||
| **Install the Light CLI:** | ||||||
|
|
||||||
| ```bash | ||||||
| npm -g i @lightprotocol/zk-compression-cli | ||||||
| ``` | ||||||
|
|
||||||
| ```bash | ||||||
| ### verify installation | ||||||
| light --version | ||||||
| ``` | ||||||
|
|
||||||
| ### Initialize your Program | ||||||
|
|
||||||
| Instantiate a template Solana program with compressed accounts with all required dependencies. | ||||||
|
|
||||||
| ```bash | ||||||
| light init testprogram | ||||||
| ``` | ||||||
|
|
||||||
| <Info> | ||||||
| The `light init` command creates only Anchor-based projects . For Pinocchio programs, manually configure dependencies using `light-sdk-pinocchio`. | ||||||
| </Info> | ||||||
|
|
||||||
| <Accordion title="Dependencies"> | ||||||
|
|
||||||
| **Rust Crates** | ||||||
|
|
||||||
| * `light-sdk` - Core SDK for compressed accounts in native and anchor programs | ||||||
| * `light-sdk-pinocchio` Core SDK for compressed accounts in pinocchio programs | ||||||
|
Contributor
There was a problem hiding this comment. Minor formatting issue in Rust crates list. Line 86 is missing a dash separator between the package name and description, inconsistent with the line above and below. Apply this diff: -* `light-sdk-pinocchio` Core SDK for compressed accounts in pinocchio programs
+* `light-sdk-pinocchio` - Core SDK for compressed accounts in pinocchio programs📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||
| * `light-client` - RPC client and indexer for interacting with compressed accounts | ||||||
| * `light-program-test` - Testing utilities for compressed programs. | ||||||
|
|
||||||
| **TypeScript/JavaScript Packages** | ||||||
|
|
||||||
| * `@lightprotocol/stateless.js` - Client library for interacting with compressed accounts | ||||||
| * `@lightprotocol/zk-compression-cli` - Command-line tools for ZK compression development | ||||||
|
|
||||||
| </Accordion> | ||||||
|
|
||||||
| ### Build and Test | ||||||
|
|
||||||
| Now `cd testprogram` and run: | ||||||
|
|
||||||
| ```bash | ||||||
| anchor build | ||||||
| # Success: Finished `release` profile [optimized] target(s), after compiling. | ||||||
| # Note: Stack offset warnings are expected and don't prevent compilation | ||||||
| ``` | ||||||
|
|
||||||
| ```bash | ||||||
| cargo test-sbf | ||||||
|
|
||||||
| # Success: test result: ok. 1 passed; 0 failed; 0 ignored | ||||||
| ``` | ||||||
|
|
||||||
| ### Common Errors | ||||||
|
|
||||||
| <Accordion title="assert.h file not found - during compilation."> | ||||||
|
|
||||||
| ```shellscript | ||||||
| Fix: | ||||||
| In your terminal, run: | ||||||
| 1. export CC=$(xcrun -find clang) | ||||||
| 2. export SDKROOT=$(xcrun --show-sdk-path) | ||||||
| 3. cargo clean | ||||||
| 4. anchor build | ||||||
|
|
||||||
|
|
||||||
| Example log: | ||||||
| The following warnings were emitted during compilation: | ||||||
|
|
||||||
| warning: blake3@1.5.1: In file included from c/blake3_neon.c:1: | ||||||
| warning: blake3@1.5.1: c/blake3_impl.h:4:10: fatal error: 'assert.h' file not found | ||||||
| warning: blake3@1.5.1: 4 | #include <assert.h> | ||||||
| warning: blake3@1.5.1: | ^~~~~~~~~~ | ||||||
| warning: blake3@1.5.1: 1 error generated. | ||||||
|
|
||||||
| error: failed to run custom build command for `blake3 v1.5.1` | ||||||
|
|
||||||
| Caused by: | ||||||
| process didn't exit successfully: `/Users/you/testprogram/target/release/build/blake3-ac41d29c2eabe052/build-script-build` (exit status: 1) | ||||||
| --- stdout | ||||||
| cargo:rerun-if-env-changed=CARGO_FEATURE_PURE | ||||||
| cargo:rerun-if-env-changed=CARGO_FEATURE_NO_NEON | ||||||
| cargo:rerun-if-env-changed=CARGO_FEATURE_NEON | ||||||
| cargo:rerun-if-env-changed=CARGO_FEATURE_NEON | ||||||
| cargo:rerun-if-env-changed=CARGO_FEATURE_NO_NEON | ||||||
| cargo:rerun-if-env-changed=CARGO_FEATURE_PURE | ||||||
| cargo:rustc-cfg=blake3_neon | ||||||
| OUT_DIR = Some(/Users/you/testprogram/target/release/build/blake3-735a4c71d985df30/out) | ||||||
| TARGET = Some(aarch64-apple-darwin) | ||||||
| OPT_LEVEL = Some(3) | ||||||
| HOST = Some(aarch64-apple-darwin) | ||||||
| cargo:rerun-if-env-changed=CC_aarch64-apple-darwin | ||||||
| CC_aarch64-apple-darwin = None | ||||||
| cargo:rerun-if-env-changed=CC_aarch64_apple_darwin | ||||||
| CC_aarch64_apple_darwin = None | ||||||
| cargo:rerun-if-env-changed=HOST_CC | ||||||
| HOST_CC = None | ||||||
| cargo:rerun-if-env-changed=CC | ||||||
| CC = Some(/Users/you/.local/share/solana/install/releases/1.18.22/solana-release/bin/sdk/sbf/dependencies/platform-tools/llvm/bin/clang) | ||||||
| RUSTC_WRAPPER = None | ||||||
| cargo:rerun-if-env-changed=CC_ENABLE_DEBUG_OUTPUT | ||||||
| cargo:rerun-if-env-changed=CRATE_CC_NO_DEFAULTS | ||||||
| CRATE_CC_NO_DEFAULTS = None | ||||||
| DEBUG = Some(false) | ||||||
| cargo:rerun-if-env-changed=MACOSX_DEPLOYMENT_TARGET | ||||||
| MACOSX_DEPLOYMENT_TARGET = None | ||||||
| cargo:rerun-if-env-changed=CFLAGS_aarch64-apple-darwin | ||||||
| CFLAGS_aarch64-apple-darwin = None | ||||||
| cargo:rerun-if-env-changed=CFLAGS_aarch64_apple_darwin | ||||||
| CFLAGS_aarch64_apple_darwin = None | ||||||
| cargo:rerun-if-env-changed=HOST_CFLAGS | ||||||
| HOST_CFLAGS = None | ||||||
| cargo:rerun-if-env-changed=CFLAGS | ||||||
| CFLAGS = None | ||||||
| cargo:warning=In file included from c/blake3_neon.c:1: | ||||||
| cargo:warning=c/blake3_impl.h:4:10: fatal error: 'assert.h' file not found | ||||||
| cargo:warning= 4 | #include <assert.h> | ||||||
| cargo:warning= | ^~~~~~~~~~ | ||||||
| cargo:warning=1 error generated. | ||||||
|
|
||||||
| --- stderr | ||||||
|
|
||||||
|
|
||||||
| error occurred: Command env -u IPHONEOS_DEPLOYMENT_TARGET "/Users/you/.local/share/solana/install/releases/1.18.22/solana-release/bin/sdk/sbf/dependencies/platform-tools/llvm/bin/clang" "-O3" "-ffunction-sections" "-fdata-sections" "-fPIC" "--target=arm64-apple-darwin" "-mmacosx-version-min=14.4" "-Wall" "-Wextra" "-std=c11" "-o" "/Users/you/testprogram/target/release/build/blake3-735a4c71d985df30/out/db3b6bfb95261072-blake3_neon.o" "-c" "c/blake3_neon.c" with args clang did not execute successfully (status code exit status: 1). | ||||||
| ``` | ||||||
|
|
||||||
| </Accordion> | ||||||
|
|
||||||
| ## Program Examples | ||||||
| | Example | Description | | ||||||
| |:---------|:------------| | ||||||
| | [basic-operations/anchor](https://github.com/Lightprotocol/program-examples/tree/main/basic-operations/anchor) | Anchor programs to create, update, close, reinitialize and burn compressed accounts with Rust and TypeScript tests | | ||||||
| | [basic-operations/native-rust](https://github.com/Lightprotocol/program-examples/tree/main/basic-operations/native-rust) | Native Solana program implementation to create, update, close, reinitialize and burn compressed accounts with Rust tests | | ||||||
| | [Counter (Anchor)](https://github.com/Lightprotocol/program-examples/tree/main/counter/anchor) | Full compressed account lifecycle (create, increment, decrement, reset, close) using Anchor framework | | ||||||
| | [Counter (Native)](https://github.com/Lightprotocol/program-examples/tree/main/counter/native) | Native Solana program implementation with Rust tests | | ||||||
| | [Counter (Pinocchio)](https://github.com/Lightprotocol/program-examples/tree/main/counter/pinocchio) | Pinocchio implementation using light-sdk-pinocchio with Rust tests | | ||||||
| | [Create-and-Update](https://github.com/Lightprotocol/program-examples/tree/main/create-and-update) | Create new compressed accounts and update existing ones within a single instruction and one validity proof | | ||||||
| | [Read-Only](https://github.com/Lightprotocol/program-examples/tree/main/read-only) | Create compressed accounts and read them on-chain | | ||||||
| | [Account Comparison](https://github.com/Lightprotocol/program-examples/tree/main/account-comparison) | Compare compressed accounts with standard Solana accounts | | ||||||
| | [ZK-ID](https://github.com/Lightprotocol/program-examples/tree/main/zk-id) | Program that uses zero-knowledge proofs for identity verification with compressed accounts | | ||||||
|
Comment on lines
+189
to
+199
Contributor
There was a problem hiding this comment. 🧩 Analysis chainVerify all program example links are valid and current. The program examples table references 9 GitHub repositories. Verify that all links:
🏁 Script executed: #!/bin/bash
# Description: Verify GitHub program example links
EXAMPLES=(
"https://github.com/Lightprotocol/program-examples/tree/main/basic-operations/anchor"
"https://github.com/Lightprotocol/program-examples/tree/main/basic-operations/native-rust"
"https://github.com/Lightprotocol/program-examples/tree/main/counter/anchor"
"https://github.com/Lightprotocol/program-examples/tree/main/counter/native"
"https://github.com/Lightprotocol/program-examples/tree/main/counter/pinocchio"
"https://github.com/Lightprotocol/program-examples/tree/main/create-and-update"
"https://github.com/Lightprotocol/program-examples/tree/main/read-only"
"https://github.com/Lightprotocol/program-examples/tree/main/account-comparison"
"https://github.com/Lightprotocol/program-examples/tree/main/zk-id"
)
echo "Checking GitHub repository links..."
for url in "${EXAMPLES[@]}"; do
STATUS=$(curl -s -o /dev/null -w "%{http_code}" "$url")
REPO=$(echo "$url" | cut -d'/' -f5-)
if [ "$STATUS" = "200" ]; then
echo "✓ $REPO"
else
echo "✗ $REPO (HTTP $STATUS)"
fi
doneLength of output: 461 Fix broken link: The GitHub link for the
Eight of the nine links verified successfully, but this broken reference will frustrate users attempting to access the documentation. 🤖 Prompt for AI Agents |
||||||
|
|
||||||
|
|
||||||
| ## Next Steps | ||||||
|
|
||||||
| Start building with compressed accounts using our guides or program examples. | ||||||
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,84 @@ | ||||||||||||||
| --- | ||||||||||||||
| title: Guides | ||||||||||||||
| description: Overview and comparison of guides to create, update, close, reinitialize, and burn permanently compressed accounts. Guides include step-by-step implementation and full code examples. | ||||||||||||||
| sidebarTitle: "Overview" | ||||||||||||||
| --- | ||||||||||||||
|
|
||||||||||||||
| ## Guides Overview | ||||||||||||||
|
|
||||||||||||||
| | Guide | Description | | ||||||||||||||
| | ------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | | ||||||||||||||
| | [Create Compressed Accounts](/compressed-pdas/guides/how-to-create-compressed-accounts) | Create compressed accounts with address | | ||||||||||||||
| | [Update Compressed Accounts](/compressed-pdas/guides/how-to-update-compressed-accounts) | Update compressed accounts | | ||||||||||||||
| | [Close Compressed Accounts](/compressed-pdas/guides/how-to-close-compressed-accounts) | Close compressed accounts, retain the address | | ||||||||||||||
| | [Reinitialize Compressed Accounts](/compressed-pdas/guides/how-to-reinitialize-compressed-accounts) | Reinitialize closed compressed accounts with the same address and new values | | ||||||||||||||
| | [Burn Compressed Accounts](/compressed-pdas/guides/how-to-burn-compressed-accounts) | Burn compressed accounts and their address permanently | | ||||||||||||||
|
|
||||||||||||||
| ## Complete Flow Overview | ||||||||||||||
|
|
||||||||||||||
| <Tabs> | ||||||||||||||
| <Tab title="Create"> | ||||||||||||||
| <div className="hidden dark:block"> | ||||||||||||||
| <Frame> | ||||||||||||||
|  | ||||||||||||||
| </Frame> | ||||||||||||||
| </div> | ||||||||||||||
| <div className="block dark:hidden"> | ||||||||||||||
| <Frame> | ||||||||||||||
|  | ||||||||||||||
| </Frame> | ||||||||||||||
| </div> | ||||||||||||||
| </Tab> | ||||||||||||||
| <Tab title="Update"> | ||||||||||||||
| <div className="hidden dark:block"> | ||||||||||||||
| <Frame> | ||||||||||||||
|  | ||||||||||||||
| </Frame> | ||||||||||||||
| </div> | ||||||||||||||
| <div className="block dark:hidden"> | ||||||||||||||
| <Frame> | ||||||||||||||
|  | ||||||||||||||
| </Frame> | ||||||||||||||
| </div> | ||||||||||||||
| </Tab> | ||||||||||||||
| <Tab title="Close"> | ||||||||||||||
| <div className="hidden dark:block"> | ||||||||||||||
| <Frame> | ||||||||||||||
|  | ||||||||||||||
| </Frame> | ||||||||||||||
| </div> | ||||||||||||||
| <div className="block dark:hidden"> | ||||||||||||||
| <Frame> | ||||||||||||||
|  | ||||||||||||||
| </Frame> | ||||||||||||||
| </div> | ||||||||||||||
| </Tab> | ||||||||||||||
| <Tab title="Reinitialize"> | ||||||||||||||
| <div className="hidden dark:block"> | ||||||||||||||
| <Frame> | ||||||||||||||
|  | ||||||||||||||
| </Frame> | ||||||||||||||
| </div> | ||||||||||||||
| <div className="block dark:hidden"> | ||||||||||||||
| <Frame> | ||||||||||||||
|  | ||||||||||||||
| </Frame> | ||||||||||||||
| </div> | ||||||||||||||
| </Tab> | ||||||||||||||
| <Tab title="Burn"> | ||||||||||||||
| <div className="hidden dark:block"> | ||||||||||||||
| <Frame> | ||||||||||||||
|  | ||||||||||||||
| </Frame> | ||||||||||||||
| </div> | ||||||||||||||
| <div className="block dark:hidden"> | ||||||||||||||
| <Frame> | ||||||||||||||
|  | ||||||||||||||
| </Frame> | ||||||||||||||
| </div> | ||||||||||||||
| </Tab> | ||||||||||||||
| </Tabs> | ||||||||||||||
|
|
||||||||||||||
| ## Next Steps | ||||||||||||||
|
|
||||||||||||||
| Create a compressed account. | ||||||||||||||
|
Comment on lines
+82
to
+84
Contributor
There was a problem hiding this comment. Next Steps section is vague; add a specific guide link. Line 84 states "Create a compressed account" without a corresponding link. This should direct users to a specific guide (e.g., Consider this diff: -## Next Steps
-
-Create a compressed account.
+## Next Steps
+
+Ready to start? [Create your first compressed account](/compressed-pdas/guides/how-to-create-compressed-accounts).📝 Committable suggestion
Suggested change
🤖 Prompt for AI Agents |
||||||||||||||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧹 Nitpick | 🔵 Trivial
Add language specifier to fenced code block.
Line 19 code block should declare bash language for syntax highlighting.
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
19-19: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents