docs(api): align examples with exported signatures

[KimHyeongRae0]

Summary

• Update API reference examples to use exported function signatures that match the current package API.
• Clarify that schema and Open Graph helpers operate on resolved config and page entries.
• Refresh audit, citability, report, and platform-hint snippets so they are copy-pasteable.

Validation

• git diff --check main..HEAD
• npm run build

[vercel]

@KimHyeongRae0 is attempting to deploy a commit to the Cytonic Team on Vercel.

A member of the Team first needs to authorize it.

[claude]

Claude Code Review

This pull request is from a fork — automated review is disabled. A repository maintainer can comment @claude review to run a one-time review.

[greptile-apps]

Greptile Summary

This PR updates the API reference and feature docs to match the current synchronous, config-based function signatures, replacing the old URL/HTML async patterns that no longer reflect the exported package API.

• audit.mdx: All four code blocks (audit, citability, report, platform hints) are now self-contained: each declares its own resolveConfig call and uses correct call sites (auditSite(config), getGrade(result.score), generatePlatformHints(audit, citability)).
• schema-og.mdx: Programmatic API section is rewritten to show the resolved-config and page-entry pattern, with correct argument order for generateOGTags(page, config) and the spread pattern for generateJsonLdScript.
• api.mdx: Section headers and inline examples are aligned throughout (flipped OG argument order, new htmlToMarkdown three-param signature, new Platform Hints section, getGrade comment updated to accurate grade labels).

Confidence Score: 5/5

Documentation-only change; no runtime code is modified.

Every updated function call site was verified against the actual TypeScript source: argument order, synchronous vs. async, parameter types, and return-type field names all match.

No files require special attention.

Important Files Changed

Filename	Overview
website/src/content/docs/features/audit.mdx	All four code blocks updated to be self-contained with correct synchronous call sites and proper argument shapes.
website/src/content/docs/features/schema-og.mdx	Programmatic API block rewritten with resolved-config + page-entry pattern and correct argument order for OG helpers.
website/src/content/docs/reference/api.mdx	Section headers and snippets aligned with actual exported signatures; new Platform Hints section added.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["resolveConfig(partialConfig)"] --> B["ResolvedAeoConfig"]
    B --> C["auditSite(config)"]
    B --> D["scoreSiteCitability(config)"]
    B --> E["generateSchemaObjects(config)"]
    B --> F["generateReport(config)"]
    C --> G["AuditResult"]
    D --> H["SiteCitabilityResult"]
    G & H --> I["generatePlatformHints(audit, citability)"]
    E --> J["SchemaOutput"]
    J --> K["generateJsonLdScript(schemas)"]
    B --> L["generateOGTags(page, config)"]
    B --> M["generateOGTagsHtml(page, config)"]

Loading

_{Reviews (3): Last reviewed commit: "docs(schema-og): declare programmatic ap..." | Re-trigger Greptile}

[rubenmarcus]

Thanks @KimHyeongRae0 — keeping API docs aligned with the exported signatures is exactly the kind of paper-cut work that compounds well. No findings from Greptile or my read. Ready to merge once the other queue is cleared.

[KimHyeongRae0]

Sounds good, thanks.