docs(course-registry): rewrite README to match actual API - #72
Open
Degentle12 wants to merge 1 commit into
Open
Conversation
- Replace all stale function signatures with actual code-matched signatures - Document all 16 public functions with params, returns, and panics - Add event types table with topics and data columns - Add storage layout table covering all DataKey variants - Add auth model table showing who can call what - Document cross-contract wiring (BadgeNFT, RewardPool) - Add constants and versioning information Closes Kqirox#10
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
contracts/course-registry/README.mddescribed an API contract that didn't match the actual code — stale function signatures, wrong event types, incorrect storage keys, and misleading security guidance.Solution
Complete rewrite of the README covering:
DataKey::*variants (instance + persistent)Closes #10