Skip to content

Commit 5a75d1a

Browse files
committed
docs: Add comprehensive API reference documentation (Issue #16)
Created 3 complete API reference pages: 1. CLI Commands (api/cli-commands.md) - All 4 commands: generate, validate, init, check - Usage examples, options, exit codes - Common errors and troubleshooting - CI/CD integration examples 2. Type System (api/types.md) - Complete type mapping table (Rust ↔ TypeScript) - Primitives: u8-u128, i8-i128, bool, String - Solana types: PublicKey, Signature - Complex types: Vec, Option - Enums: Unit, Tuple, Struct variants - Best practices and constraints 3. Attributes (api/attributes.md) - #[solana] - Solana-specific types - #[account] - Anchor account macro - Context-aware generation - Valid/invalid combinations - Troubleshooting common errors Updated sidebar navigation to include API Reference section. Progress: 75% complete on Issue #16
1 parent 8557e31 commit 5a75d1a

File tree

4 files changed

+1501
-8
lines changed

4 files changed

+1501
-8
lines changed

astro.config.mjs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,14 @@ export default defineConfig({
4848
{ label: 'Quick Start', slug: 'getting-started/quick-start' },
4949
],
5050
},
51+
{
52+
label: 'API Reference',
53+
items: [
54+
{ label: 'CLI Commands', slug: 'api/cli-commands' },
55+
{ label: 'Type System', slug: 'api/types' },
56+
{ label: 'Attributes', slug: 'api/attributes' },
57+
],
58+
},
5159
// TODO: Add these sections as we create the content
5260
// {
5361
// label: 'Guides',
@@ -59,14 +67,6 @@ export default defineConfig({
5967
// ],
6068
// },
6169
// {
62-
// label: 'API Reference',
63-
// items: [
64-
// { label: 'CLI Commands', slug: 'api/cli-commands' },
65-
// { label: 'Parser', slug: 'api/parser' },
66-
// { label: 'Generators', slug: 'api/generators' },
67-
// ],
68-
// },
69-
// {
7070
// label: 'Examples',
7171
// items: [
7272
// { label: 'Gaming Platform', slug: 'examples/gaming' },

0 commit comments

Comments
 (0)