Skip to content

docs: clarify off-site AI visibility limits (closes #53) #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rubenmarcus merged 1 commit into from
May 14, 2026
Merged

docs: clarify off-site AI visibility limits (closes #53) #58

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions website/src/content/docs/getting-started/introduction.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Introduction
description: What is aeo.js and why you need Answer Engine Optimization.
---

import { Aside } from '@astrojs/starlight/components';

![aeo.js in action](/example.webp)

## What is Answer Engine Optimization?
Expand Down Expand Up @@ -30,6 +32,30 @@ AI crawlers and LLMs look for specific files and formats that most websites don'
3. **aeo.js** scans your output, extracts content, and generates all AEO files
4. The optional **widget** lets visitors toggle between human and AI views of your pages

## Scope: what aeo.js does and doesn't influence

AEO is the **on-site** half of being discoverable by AI engines — there's an off-site half that aeo.js cannot reach. Setting expectations upfront so you can plan a full strategy:

<Aside type="note" title="What aeo.js does well">
Improves machine-readable access to **your own site**:

- generates `llms.txt`, `llms-full.txt`, `ai-index.json`, raw markdown copies, JSON-LD schema, and a sitemap
Copy link
Copy Markdown

@greptile-apps greptile-apps Bot May 14, 2026

Choose a reason for hiding this comment

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

P2 The "Why aeo.js?" section above lists docs.json as one of the files aeo.js generates, but this Aside omits it. A reader comparing the two sections will notice the inconsistency and wonder whether docs.json is no longer produced or was intentionally excluded from scope.

Suggested change
- generates `llms.txt`, `llms-full.txt`, `ai-index.json`, raw markdown copies, JSON-LD schema, and a sitemap
- generates `llms.txt`, `llms-full.txt`, `ai-index.json`, `docs.json`, raw markdown copies, JSON-LD schema, and a sitemap
Prompt To Fix With AI 
This is a comment left during a code review.
Path: website/src/content/docs/getting-started/introduction.mdx
Line: 42

Comment:
The "Why aeo.js?" section above lists `docs.json` as one of the files aeo.js generates, but this Aside omits it. A reader comparing the two sections will notice the inconsistency and wonder whether `docs.json` is no longer produced or was intentionally excluded from scope.

```suggestion
- generates `llms.txt`, `llms-full.txt`, `ai-index.json`, `docs.json`, raw markdown copies, JSON-LD schema, and a sitemap
```

How can I resolve this? If you propose a fix, please make it concise.

- structures content so AI crawlers can fetch, parse, and quote it
- audits and scores your page-level citability so you know where to improve
</Aside>

<Aside type="caution" title="What aeo.js cannot influence">
Off-site signals that AI engines also weigh:

- **third-party mentions and reviews** of your product across the web
- **inbound links** and how reputable the linking domains are
- **community discussions** (Reddit, Hacker News, X, niche forums) and how often you're cited there
- **model training data** — what an LLM "already knows" about you from its pre-training cutoff
- **freshness signals** outside your control (independent news, blog roundups, podcasts)
</Aside>

Think of aeo.js as a strong foundation — necessary but not sufficient. For full AEO coverage, pair it with the off-site work above: PR, community engagement, and being mentioned where your customers research.
Copy link
Copy Markdown

@greptile-apps greptile-apps Bot May 14, 2026

Choose a reason for hiding this comment

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

P2 In a developer-facing doc, "PR" is almost universally read as "pull request." Spelling out "public relations" avoids any momentary confusion for the target audience.

Suggested change
Think of aeo.js as a strong foundation — necessary but not sufficient. For full AEO coverage, pair it with the off-site work above: PR, community engagement, and being mentioned where your customers research.
Think of aeo.js as a strong foundation — necessary but not sufficient. For full AEO coverage, pair it with the off-site work above: public relations, community engagement, and being mentioned where your customers research.
Prompt To Fix With AI 
This is a comment left during a code review.
Path: website/src/content/docs/getting-started/introduction.mdx
Line: 57

Comment:
In a developer-facing doc, "PR" is almost universally read as "pull request." Spelling out "public relations" avoids any momentary confusion for the target audience.

```suggestion
Think of aeo.js as a strong foundation — necessary but not sufficient. For full AEO coverage, pair it with the off-site work above: public relations, community engagement, and being mentioned where your customers research.
```

How can I resolve this? If you propose a fix, please make it concise.


## Supported Frameworks

| Framework | Import |
Expand Down
Loading