Skip to content

Add docs-sync skill and sync Sui#151

Merged
stevep0z merged 5 commits into
OpenZeppelin:mainfrom
ericnordelo:feat/add-docs-sync-skills
May 12, 2026
Merged

Add docs-sync skill and sync Sui#151
stevep0z merged 5 commits into
OpenZeppelin:mainfrom
ericnordelo:feat/add-docs-sync-skills

Conversation

@ericnordelo
Copy link
Copy Markdown
Member

Summary

Two things land together on this branch:

1. New docs-sync skill

A 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.

  • Frontmatter inputs schema — 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 of SKILL.md and gathered by the harness.
  • Four-gate interactive flow — G1 (inputs & config), G2 (public API delta), G3 (docs edit plan), G4 (per-page broad rewrite). Each gate emits a structured proposal and ends the turn until the user replies "approve". automatic mode skips gates and writes proposal contents to the report.
  • Deterministic 18-step process (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.
  • Reference material:
    • 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.
  • First slice config: config/libraries/contracts-sui.yml covers the contracts-sui 1.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 new openzeppelin_fp_math package (~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, pow caveats, min() boundary, mod vs rem, worked examples.

Existing pages updated:

  • api/math.mdx — added is_power_of_ten to all width modules, added a vector module section (quick_sort!, quick_sort_by! macros), bumped all source links from v1.0.0 to v1.1.0.
  • api/access.mdx — bumped source links to v1.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.mdx and contracts-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.

@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 29, 2026

Deploy Preview for openzeppelin-docs-v2 ready!

Name Link
🔨 Latest commit 21a9181
🔍 Latest deploy log https://app.netlify.com/projects/openzeppelin-docs-v2/deploys/6a0353d5967c64000861bd77
😎 Deploy Preview https://deploy-preview-151--openzeppelin-docs-v2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@stevep0z stevep0z requested review from a team and stevep0z as code owners May 12, 2026 16:22
Copy link
Copy Markdown
Collaborator

@stevep0z stevep0z left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed, we will roll out Skills work within this PR for the docs, but iterate and improve upon it. Just like the docs, the skills workflows are "living."

The docs associated to v1.1 for Sui Libraries looks good. Thanks for your great work @ericnordelo !

@stevep0z stevep0z merged commit 17a4b89 into OpenZeppelin:main May 12, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants