Skip to content

docs: AI-discoverability polish for contracts-sui landing#191

Merged
bidzyyys merged 4 commits into
mainfrom
docs/contracts-sui-ai-polish
Jun 23, 2026
Merged

docs: AI-discoverability polish for contracts-sui landing#191
bidzyyys merged 4 commits into
mainfrom
docs/contracts-sui-ai-polish

Conversation

@bidzyyys

@bidzyyys bidzyyys commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

AI-discoverability polish for the Contracts for Sui docs landing.

Landing (content/contracts-sui/index.mdx):

  • llms.txt callout → raw (agents get clean text, not the GitHub HTML wrapper).
  • Added a page description (renders as lead + meta for crawlers/agents); removed the now-redundant intro paragraph.
  • Cards (Packages + API Reference): alphabetical, added the missing Utilities card, button-length descriptions; API cards mention error conditions.

Root public/llms.txt:

  • Regenerated the Sui section only (was stale): adds Fixed-Point Math + Utils (Packages + API), Access subpages, updated Learn, and picks up the new page description. Other products untouched.

Scope: existing/published packages (access, fixed-point, integer-math, utils).

- llms.txt callout -> raw (clean text, not the GitHub HTML wrapper)
- intro reframed to secure/audited/production-ready (no fragile category list)
- cards: alphabetical, add Utilities, button-length descriptions
@bidzyyys bidzyyys requested a review from a team as a code owner June 23, 2026 22:27
@netlify

netlify Bot commented Jun 23, 2026

Copy link
Copy Markdown

Deploy Preview for openzeppelin-docs-v2 ready!

Name Link
🔨 Latest commit 9f186eb
🔍 Latest deploy log https://app.netlify.com/projects/openzeppelin-docs-v2/deploys/6a3b103ad48b400008005809
😎 Deploy Preview https://deploy-preview-191--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 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM! Thanks!

@bidzyyys bidzyyys merged commit d24cf40 into main Jun 23, 2026
11 checks passed
@bidzyyys bidzyyys deleted the docs/contracts-sui-ai-polish branch June 23, 2026 23:22
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