Skip to content

Documentation improvements and code snippet fixes #13

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.

Sign up for GitHub

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 2 commits into from
Nov 9, 2025
Merged

Documentation improvements and code snippet fixes #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
23f1d96
Fix code snippet accuracy issues in client-guide.md
Nov 9, 2025
8cc47b4
Fix formatting and remove misleading Rust comment
Nov 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion zk-compression-docs/CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,4 +285,4 @@ References
├── Terminology (references/terminology.md)
└── Security (references/security.md)
└── audits: <https://github.com/Lightprotocol/light-protocol/tree/main/audits>
```
```
6 changes: 3 additions & 3 deletions zk-compression-docs/compressed-pdas/client-library/client-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ Start a start a single-node Solana cluster, an RPC node, and a prover node at po

```typescript
const lightWasm: LightWasm = await WasmFactory.getInstance();
const testRpc = await getTestRpc(lightWasm);
const testRpc = await TestRpc.create(lightWasm);
```
{% endtab %}

Expand Down Expand Up @@ -720,12 +720,12 @@ Populate the `systemAccounts` section with Light System accounts. These accounts

{% code overflow="wrap" %}
```typescript
const systemAccountConfig = new SystemAccountMetaConfig(programId);
const systemAccountConfig = SystemAccountMetaConfig.new(programId);
packedAccounts.addSystemAccounts(systemAccountConfig);
```
{% endcode %}
Comment on lines 720 to 726
Copy link
Contributor

@coderabbitai coderabbitai bot Nov 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Add blank line before code fence (MD031).

Markdown linting indicates that code fences should be surrounded by blank lines. A blank line is needed before line 720 ({% code overflow="wrap" %}).

Apply this diff to fix the formatting:

 2. Call `addSystemAccounts(systemAccountConfig)` - the SDK populates `systemAccounts` with Light System accounts, including the CPI signer PDA derived from your program ID

+
 {% code overflow="wrap" %}
 ```typescript
 const systemAccountConfig = SystemAccountMetaConfig.new(programId);
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)

722-722: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

725-725: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

🤖 Prompt for AI Agents 
In zk-compression-docs/compressed-pdas/client-library/client-guide.md around
lines 720 to 726, the code fence starting with `{% code overflow="wrap" %}`
needs a blank line above it to satisfy MD031; insert a single blank line
immediately before the `{% code overflow="wrap" %}` line so the fenced code
block is separated from the preceding paragraph/content.


1. Pass your program ID to `new SystemAccountMetaConfig(programId)` to configure system accounts
1. Pass your program ID to `SystemAccountMetaConfig.new(programId)` to configure system accounts
2. Call `addSystemAccounts(systemAccountConfig)` - the SDK populates `systemAccounts` with Light System accounts, including the CPI signer PDA derived from your program ID

{% hint style="info" %}
Expand Down