Restructure documentation for plugin-first information architecture#1502
Open
lorisleiva wants to merge 1 commit intomainfrom
Open
Restructure documentation for plugin-first information architecture#1502lorisleiva wants to merge 1 commit intomainfrom
lorisleiva wants to merge 1 commit intomainfrom
Conversation
|
BundleMonUnchanged files (142)
No change in files bundle size Final result: ✅ View report in BundleMon website ➡️ |
Contributor
|
Documentation Preview: https://kit-docs-8hdndtyld-anza-tech.vercel.app |
lorisleiva
force-pushed
the
03-27-restructure_documentation_for_plugin-first_information_architecture
branch
from
e080cca to
e0a366f
Compare
#### Problem
The current solanakit.com documentation teaches Kit from the low-level primitives up: manually creating RPC connections, hand-building Client types, constructing transaction messages with `pipe()`, etc. Now that Kit Plugins and ready-made clients exist (`@solana/kit-client-rpc`, `@solana/kit-client-litesvm`), the documentation should lead with the simpler plugin-based approach and position the lower-level Kit APIs as advanced content.
#### Summary of Changes
This PR restructures the documentation's information architecture without deleting any existing content. Every new page is a stub with a detailed "Planned Content" callout describing what will be written. Every existing page that will be updated or removed has a banner explaining the plan. The site builds and is fully navigable for review.
```
Documentation
├── Installation 📝
├── Upgrade Guide 📝
├── ❌ Compatible Clients 🗑️
├── Getting Started
│ ├── Overview 📝
│ ├── Set up your project 📝
│ ├── Interact with programs 🆕
│ ├── Send a transaction 🆕
│ ├── Fetch an account 🆕
│ ├── Going to production 🆕
│ ├── Testing with LiteSVM 🆕
│ ├── Customizing the client 🆕
│ ├── ───
│ ├── ❌ Generate a signer 🗑️
│ ├── ❌ Create instructions 🗑️
│ ├── ❌ Build a transaction 🗑️
│ ├── ❌ Send a transaction 🗑️
│ └── ❌ Fetch an account 🗑️
├── Guides
│ ├── Overview 🆕
│ ├── Setting fee payers 🆕
│ ├── Sending transactions 🆕
│ ├── Sending multiple transactions 🆕
│ ├── Fetching accounts 🆕
│ ├── Using program plugins 🆕
│ └── Testing & local development 🆕
├── Clients & Plugins
│ ├── Overview 🆕
│ ├── Available clients 🆕
│ ├── Available plugins 🆕
│ ├── Creating custom plugins 🆕
│ ├── Generating program plugins 🆕
│ └── Creating custom clients 🆕
└── Advanced Guides (renamed from Core Concepts)
├── Overview 📝
├── Kit without a client 🆕
├── Key pairs
├── Signers 📝
├── Transactions 📝
├── Codecs
├── RPC requests 📝
├── RPC subscriptions 📝
├── Errors 📝
├── Offchain messages
└── Instruction plans 📝
Recipes (new top-level section)
├── Overview 🆕
├── Transferring SOL 🆕
├── Creating a token 🆕
└── Airdropping tokens 🆕
🆕 = new stub page
📝 = existing page with planned updates
🗑️ = existing page scheduled for removal
(no emoji) = unchanged
```
lorisleiva
force-pushed
the
03-27-restructure_documentation_for_plugin-first_information_architecture
branch
from
e0a366f to
782fcfd
Compare
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
1 participant
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.
Problem
The current solanakit.com documentation teaches Kit from the low-level primitives up: manually creating RPC connections, hand-building Client types, constructing transaction messages with
pipe(), etc. Now that Kit Plugins and ready-made clients exist (@solana/kit-client-rpc,@solana/kit-client-litesvm), the documentation should lead with the simpler plugin-based approach and position the lower-level Kit APIs as advanced content.Summary of Changes
This PR restructures the documentation's information architecture without deleting any existing content. Every new page is a stub with a detailed "Planned Content" callout describing what will be written. Every existing page that will be updated or removed has a banner explaining the plan. The site builds and is fully navigable for review.