docs(lez): Extensions section with admin-authority and extension-library guides#355
Draft
mmlado wants to merge 1 commit into
Draft
docs(lez): Extensions section with admin-authority and extension-library guides#355mmlado wants to merge 1 commit into
mmlado wants to merge 1 commit into
Conversation
…library guides
Two new pages under docs/lez/extensions/:
- admin-authority.md: integration guide for app developers. Covers
annotation, gating, AdminCandidate (Signer / PDA), initialization
window, transfer, renounce, verification, security notes.
- build-a-spel-extension-library.md: author guide for the generic
[package.metadata.spel] discovery mechanism. Covers two-crate
layout, metadata fields, marker / gate macros, multi-extension
stacking, troubleshooting.
SUMMARY.md updated with new section.
Relates to: RFP-001 (logos-co/rfp#46)
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
Adds two pages under a new
docs/lez/extensions/folder, plus an "Extensions" entry indocs/lez/SUMMARY.md:admin-authority.md, integration guide for app developers. Covers annotation, gating, AdminCandidate (Signer / PDA), initialization window risk, transfer, renounce, IDL verification, security notes.build-a-spel-extension-library.md, author guide for the generic[package.metadata.spel]discovery mechanism. Covers two-crate layout, metadata fields, marker / gate macros, multi-extension stacking, common troubleshooting.Context
These pages document the user-facing surface of RFP-001 (admin-authority library) and the framework mechanism it relies on. The framework mechanism, a generic
[package.metadata.spel]extension scanner inspel-framework-core::idl_gen, is delivered as a separate PR againstlogos-co/spel(see companion PR). These docs are the consumer-facing complement.Future extension libraries (e.g. RFP-002 freeze-authority) can ship without any framework change, so the "Build a SPEL extension library" page is written generically to serve as the canonical author guide for any future extension.
Why a new
extensions/folderlez/already groups capabilities by folder (get-started/,transfer-tokens/). Extension libraries are a new capability class. Placing both pages underlez/extensions/mirrors the existing structure and keeps consumer and author guides discoverable side-by-side.Companion repositories
mmlado/spel-admin-authority: the admin-authority library implementation referenced byadmin-authority.md.mmlado/spel:feat/admin_authority: the framework branch carrying the generic extension scanner referenced by both guides.Open questions for maintainers
extensions/for brevity. Alternatives:extension-libraries/,program-extensions/,access-control/(too narrow for the generic guide).lez/. The author guide could arguably sit underbuild-an-app/instead. Open to splitting if you prefer.lez/orbuild-an-app/READMEs yet, happy to add.Style notes
Pages follow the existing GitBook hint-block convention (
{% hint style="warning" %}for the draft-status banner and the initialization-window warning). Heading depth and table style matchdocs/build-an-app/tutorials/.Relates to