Add docs-sync skill and sync Sui#151
Open
ericnordelo wants to merge 4 commits intoOpenZeppelin:mainfrom
Open
Conversation
✅ Deploy Preview for openzeppelin-docs-v2 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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
Two things land together on this branch:
1. New
docs-syncskillA reusable agent skill (
skills/docs-sync/) for keeping the centralized docs repo in sync with smart-contracts library releases. The skill takes two contract commits as the source of truth and produces docs edits that follow the Diátaxis framework.inputsschema — required fields (contracts_repo_path,base_commit,head_commit,library_id,docs_version,release_version) and optional fields (mode,docs_repo_path,docs_update_scope, audience/tone overrides) declared at the top ofSKILL.mdand gathered by the harness.automaticmode skips gates and writes proposal contents to the report.process.md) covering input validation, config load, contract diff computation, public API extraction, change classification, doc-update matrix lookup, edit-plan aggregation, API reference / guide / example / navigation updates, validation, and reporting.rules/— change classification, doc-update matrix, API reference rules, Diátaxis rules, PR checklist, config rules.checks/— validation specs for public API coverage, stale identifiers, code snippets, link integrity, navigation consistency.templates/— page templates for API reference, guide, tutorial, explanation.proposals/— gate-specific proposal block templates (G1–G4).reports/— final docs-sync report template.config/libraries/contracts-sui.ymlcovers thecontracts-sui1.x slice (paths, navigation system, examples style, security rules, automation defaults).2. First docs-sync run: contracts-sui 1.x for the v1.1.0 release
Applied the skill to bring the contracts-sui docs slice in sync with
9b5b807..af09be7(cumulative diff for the v1.1.0 release).New content:
content/contracts-sui/1.x/api/fixed-point.mdx— full API reference for the newopenzeppelin_fp_mathpackage (~1100 lines). Six modules:ud30x9,ud30x9_base,ud30x9_convert,sd29x9,sd29x9_base,sd29x9_convert. Every public function, struct, and error is documented.content/contracts-sui/1.x/fixed-point.mdx— package guide for fixed-point math: type selection, casting vs converting, function selection (mul/mul_trunc/mul_away, etc.), overflow semantics, comparison rules, cross-type casts, bitwise gotchas,powcaveats,min()boundary,modvsrem, worked examples.Existing pages updated:
api/math.mdx— addedis_power_of_tento all width modules, added avectormodule section (quick_sort!,quick_sort_by!macros), bumped all source links fromv1.0.0tov1.1.0.api/access.mdx— bumped source links tov1.1.0.math.mdx,access.mdx— merged the previous Learn-folder walkthroughs into the package guides as deeper sections after the quickstart. One canonical page per package now.1.x/index.mdxandcontracts-sui/index.mdx— added the third package (openzeppelin_fp_math) to the overview, MVR install instructions, and Card grids; removed the dead Learn entry.src/navigation/sui/current.json— added Fixed-Point Math under Packages and API Reference; removed the Learn folder entirely.Removed:
content/contracts-sui/1.x/learn/(3 files). Walkthrough content was merged into the corresponding package guides.