[KLC-2172] Add SKILL.md with progressive disclosure sub-files#27
Merged
fbsobreira merged 3 commits intodevelopfrom Feb 19, 2026
Merged
[KLC-2172] Add SKILL.md with progressive disclosure sub-files#27fbsobreira merged 3 commits intodevelopfrom
fbsobreira merged 3 commits intodevelopfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive LLM-optimized reference documentation for Klever blockchain development. The documentation is structured with a main SKILL.md file that serves as a hub with YAML frontmatter for IDE skill registry discovery, plus 9 progressive disclosure sub-files that provide detailed coverage of smart contract development, deployment, and best practices.
Changes:
- Added
docs/SKILL.mdwith YAML frontmatter, quick reference guide, common mistakes, and decision tree for routing to appropriate sub-guides - Added 9 detailed sub-files covering smart contracts, storage mappers, tokens/payments, events, modules, deployment, API reference, security, and troubleshooting
- Updated
CLAUDE.mdto document the new SKILL.md location and structure
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/SKILL.md | Main hub document with quick reference, common mistakes, task decision tree, and links to 9 sub-guides |
| docs/skills/01-smart-contracts.md | Contract structure, annotations, custom structs, error handling, and optional parameters |
| docs/skills/02-storage.md | Storage mapper types, declaration patterns, namespaces, atomic updates, and view functions |
| docs/skills/03-tokens.md | KLV/KFI/KDA token handling, receiving payments, sending tokens, and token identifiers |
| docs/skills/04-events.md | Event definitions, the ONE-DATA rule for non-indexed parameters, and naming conventions |
| docs/skills/05-modules.md | Built-in Admin and Pause modules with usage examples and combining modules pattern |
| docs/skills/06-deployment.md | SDK tools (ksc/koperator), build/deploy/upgrade commands, invocation, and queries |
| docs/skills/07-api-reference.md | Node API (8080) and API Proxy (9090) endpoints with usage recommendations |
| docs/skills/08-security.md | Critical security rules including validation, reentrancy prevention, and best practices |
| docs/skills/09-troubleshooting.md | Common errors with fixes and debugging tips |
| CLAUDE.md | Added documentation section describing SKILL.md location and structure |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
nickgs1337
previously approved these changes
Feb 19, 2026
RomuloSiebra
previously approved these changes
Feb 19, 2026
LLM-optimized reference for Klever blockchain development. Main file covers quick reference, common mistakes, and task routing. Nine sub-files provide detailed guides for smart contracts, storage, tokens, events, modules, deployment, API reference, security, and troubleshooting.
- Remove non-existent on-chain tools from MCP Server section, list all actual tools from server.ts - Add #![no_std], imports, #[init], #[upgrade] to Pause and Combining Modules examples for self-contained snippets - Add balance storage mapper declaration to Pause module example - Add require!(balance > 0) guard and balance.clear() before external call in emergency_withdraw examples (checks-effects-interactions) - Add users storage mapper declaration to View Functions example
fbsobreira
dismissed stale reviews from RomuloSiebra and nickgs1337
via
cfcce21
fbsobreira
force-pushed
the
feature/KLC-2172-skill-md
branch
from
e3ba45c to
cfcce21
Compare
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 11 out of 11 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Add npm "version" lifecycle script to automatically update server.json when running npm version. Also fixes server.json from stale 1.1.1 to current 1.2.3.
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.
Summary
docs/SKILL.md— LLM-optimized reference for Klever blockchain development with YAML frontmatter for IDE skill registry discoverydocs/skills/covering smart contracts, storage, tokens, events, modules, deployment, API reference, security, and troubleshootingCLAUDE.mdSKILL.md highlights
--valuesvs--value, positional args, event params, BigUint underflow, missing#[upgrade])Sub-files
Test plan
docs/SKILL.mdYAML frontmatter parses correctlyklever_scimports)0.45.0with "use latest" comment)