Skip to content

Commit bb7b33c

Browse files
committed
develop-secure-contracts: reach the API reference via the catalog Docs link
Address PR review: drop the ambiguous `.../<major>.x/api/<package>` path (the URL segment isn't the Move package name); route to the canonical API reference through each package's catalog `Docs` link instead.
1 parent 129e331 commit bb7b33c

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

skills/develop-secure-contracts/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ Don't restate Sui/Move conventions here — read them from the library's own sou
177177
- **How the library is shaped and composed** — capability-based access (witnesses/OTW), owned vs. shared objects, PTB-friendliness, initialization: [`ARCHITECTURE.md`](https://raw.githubusercontent.com/OpenZeppelin/contracts-sui/main/ARCHITECTURE.md) + the package `examples/`.
178178
- **Move 2024 idioms** — receiver/method syntax (`public use fun`), module layout, naming: [`STYLEGUIDE.md`](https://raw.githubusercontent.com/OpenZeppelin/contracts-sui/main/STYLEGUIDE.md).
179179
- **The exact `r.mvr` dependency snippet and `use` path** (the Move package name differs from the MVR slug): the package's own `README.md`.
180-
- **Exact API — signatures, parameters, events, abort conditions**: the documentation site [docs.openzeppelin.com/contracts-sui](https://docs.openzeppelin.com/contracts-sui) (concepts/guides, plus the generated API reference under `.../<major>.x/api/<package>`); the installed source and its doc-comments are the ground truth when the docs are terse.
180+
- **Exact API — signatures, parameters, events, abort conditions**: the documentation site [docs.openzeppelin.com/contracts-sui](https://docs.openzeppelin.com/contracts-sui) (concepts/guides) and the generated API reference, which you reach via the `Docs` link in each package's catalog entry rather than by guessing a URL path; the installed source and its doc-comments are the ground truth when the docs are terse.
181181
- **Toolchain, `Move.toml` (including resolving version conflicts when you combine OZ packages, e.g. an `override` on a shared math dependency), `--build-env` builds, and testing conventions**: the `setup-sui-contracts` skill.
182182

183183
As in every ecosystem, integrate by importing via MVR — never copy library source into the project.

0 commit comments

Comments
 (0)