diff --git a/website/src/content/docs/features/audit.mdx b/website/src/content/docs/features/audit.mdx index 2106b95..12b1a6d 100644 --- a/website/src/content/docs/features/audit.mdx +++ b/website/src/content/docs/features/audit.mdx @@ -8,12 +8,18 @@ description: Audit your AEO setup and measure your site's citability score. The `auditSite` function checks your site for AEO best practices and returns a detailed report: ```ts -import { auditSite, formatAuditReport, getGrade } from 'aeo.js'; +import { auditSite, formatAuditReport, getGrade, resolveConfig } from 'aeo.js'; -const result = await auditSite('https://mysite.com'); +const config = resolveConfig({ + title: 'My Site', + url: 'https://mysite.com', + pages: [{ pathname: '/', title: 'Home', content: 'Welcome to my site.' }], +}); + +const result = auditSite(config); console.log(formatAuditReport(result)); -console.log('Grade:', getGrade(result)); +console.log('Grade:', getGrade(result.score)); ``` The audit checks for: @@ -35,14 +41,24 @@ npx aeo.js check Measure how likely AI engines are to cite your content: ```ts -import { scorePageCitability, scoreSiteCitability, formatPageCitability } from 'aeo.js'; +import { formatPageCitability, resolveConfig, scorePageCitability, scoreSiteCitability } from 'aeo.js'; // Score a single page -const pageScore = await scorePageCitability(url, html); +const pageScore = scorePageCitability({ + pathname: '/', + title: 'Home', + content: '# Home\n\nMy site publishes practical guides for AI-ready content.', +}); console.log(formatPageCitability(pageScore)); // Score the whole site -const siteScore = await scoreSiteCitability('https://mysite.com', pages); +const config = resolveConfig({ + title: 'My Site', + url: 'https://mysite.com', + pages: [{ pathname: '/', title: 'Home', content: 'Welcome to my site.' }], +}); + +const siteScore = scoreSiteCitability(config); ``` The citability score evaluates: @@ -58,9 +74,15 @@ The citability score evaluates: Generate a comprehensive AEO report: ```ts -import { generateReport, formatReportMarkdown, formatReportJson } from 'aeo.js'; +import { formatReportJson, formatReportMarkdown, generateReport, resolveConfig } from 'aeo.js'; -const report = await generateReport(config); +const config = resolveConfig({ + title: 'My Site', + url: 'https://mysite.com', + pages: [{ pathname: '/', title: 'Home', content: 'Welcome to my site.' }], +}); + +const report = generateReport(config); // Get as markdown console.log(formatReportMarkdown(report)); @@ -74,8 +96,16 @@ console.log(formatReportJson(report)); Get platform-specific optimization suggestions: ```ts -import { generatePlatformHints } from 'aeo.js'; - -const hints = generatePlatformHints('next'); -// Returns hints specific to Next.js optimization +import { auditSite, generatePlatformHints, resolveConfig, scoreSiteCitability } from 'aeo.js'; + +const config = resolveConfig({ + title: 'My Site', + url: 'https://mysite.com', + pages: [{ pathname: '/', title: 'Home', content: 'Welcome to my site.' }], +}); + +const audit = auditSite(config); +const citability = scoreSiteCitability(config); +const hints = generatePlatformHints(audit, citability); +// Returns platform-specific optimization hints for ChatGPT, Perplexity, Google AI, and Bing Copilot ``` diff --git a/website/src/content/docs/features/schema-og.mdx b/website/src/content/docs/features/schema-og.mdx index ff90d01..2c98d15 100644 --- a/website/src/content/docs/features/schema-og.mdx +++ b/website/src/content/docs/features/schema-og.mdx @@ -63,21 +63,45 @@ This generates meta tags like: ## Programmatic API +The lower-level helpers expect a resolved config and a page entry. + ```ts -import { generateSchema, generateSchemaObjects, generateJsonLdScript } from 'aeo.js'; -import { generateOGTags, generateOGTagsHtml } from 'aeo.js'; +import { + generateJsonLdScript, + generateOGTags, + generateOGTagsHtml, + generateSchemaObjects, + resolveConfig, +} from 'aeo.js'; + +const page = { + pathname: '/page', + title: 'Page Title', + description: 'Page description', + content: 'Page content', +}; + +const resolvedConfig = resolveConfig({ + title: 'My Company', + description: 'My company website', + url: 'https://mysite.com', + pages: [page], +}); // Get schema objects -const schemas = generateSchemaObjects(config); +const schemas = generateSchemaObjects(resolvedConfig); // Get a