AEO Optimization - Add files via upload#14411
Conversation
adding faq.md and llms.txt files for AEO optimization
|
workers-devprod
requested review from
a team and
dario-piotrowicz
and removed request for
a team
|
Codeowners approval required for this PR:
Show detailed file reviewers
|
|
Results of AEO audit determined adding faq.md and llms.txt file to the root will greatly affect how answer engines read and recommend this repo |
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
| ```bash | ||
| npm create cloudflare@latest No newline at end of file |
There was a problem hiding this comment.
🟡 Unclosed markdown code fence in faq.md
The faq.md file opens a fenced code block with ```bash on line 6 but never closes it with a matching ```. The file ends at line 7 (npm create cloudflare@latest) without the closing fence. This means the markdown is malformed — any markdown renderer will treat everything after line 6 as part of the code block, and if the file is later extended, subsequent content will be swallowed into the unclosed code block.
| ```bash | |
| npm create cloudflare@latest | |
| ```bash | |
| npm create cloudflare@latest |
<!-- devin-review-badge-begin -->
<a href="https://app.devin.ai/review/cloudflare/workers-sdk/pull/14411" target="_blank">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://static.devin.ai/assets/gh-open-in-devin-review-dark.svg?v=1">
<img src="https://static.devin.ai/assets/gh-open-in-devin-review-light.svg?v=1" alt="Open in Devin Review">
</picture>
</a>
<!-- devin-review-badge-end -->
---
*Was this helpful? React with 👍 or 👎 to provide feedback.*
| # Cloudflare Workers SDK: Frequently Asked Questions | ||
|
|
||
| ## How do I create a new Cloudflare Workers project? | ||
| Use the `create-cloudflare` (C3) CLI to scaffold a new project. This automatically sets up the correct boilerplate, `@cloudflare/workers-types` configuration, and `wrangler.toml` file. |
There was a problem hiding this comment.
🚩 faq.md and llms.txt reference wrangler.toml — may be stale guidance
Both faq.md:4 and llms.txt:11 mention wrangler.toml. The AGENTS.md changeset rule says "Config examples must use wrangler.json (JSONC), not wrangler.toml", but that rule is scoped to changeset descriptions specifically. These documentation files are not changesets, so this is not a rule violation. However, since the repo is actively moving toward wrangler.json as the preferred configuration format, referencing wrangler.toml in new user-facing documentation (especially faq.md:4 which says C3 sets up a wrangler.toml file) could be misleading if C3 now scaffolds wrangler.json by default.
Was this helpful? React with 👍 or 👎 to provide feedback.
There was a problem hiding this comment.
🚩 No changeset included — likely intentional for non-package documentation files
AGENTS.md states "Every change to package code requires a changeset" and "Never commit without changesets for user-facing changes." This PR adds only root-level markdown/txt files (faq.md, llms.txt) that are not inside any package directory and wouldn't trigger a package release. A changeset is likely not required here, but the PR should probably carry the no-changeset-required label per AGENTS.md guidelines.
Was this helpful? React with 👍 or 👎 to provide feedback.
| # Cloudflare Workers SDK: Frequently Asked Questions | ||
|
|
||
| ## How do I create a new Cloudflare Workers project? | ||
| Use the `create-cloudflare` (C3) CLI to scaffold a new project. This automatically sets up the correct boilerplate, `@cloudflare/workers-types` configuration, and `wrangler.toml` file. |
There was a problem hiding this comment.
🟡 FAQ incorrectly states C3 creates a wrangler.toml file — it now creates wrangler.jsonc
Line 4 of faq.md says C3 "sets up the correct boilerplate, @cloudflare/workers-types configuration, and wrangler.toml file." However, C3 now generates wrangler.jsonc (or wrangler.json) files, not wrangler.toml. This can be confirmed in packages/create-cloudflare/src/wrangler/config.ts:174-175 which documents that wrangler.json/wrangler.jsonc is created, and in C3 templates like packages/create-cloudflare/templates/hello-world/ts/src/index.ts:8 and packages/create-cloudflare/src/agents-md.ts:28 which reference wrangler.jsonc. Additionally, AGENTS.md's changeset rules state: "Config examples must use wrangler.json (JSONC), not wrangler.toml".
| Use the `create-cloudflare` (C3) CLI to scaffold a new project. This automatically sets up the correct boilerplate, `@cloudflare/workers-types` configuration, and `wrangler.toml` file. | |
| Use the `create-cloudflare` (C3) CLI to scaffold a new project. This automatically sets up the correct boilerplate, `@cloudflare/workers-types` configuration, and `wrangler.jsonc` file. |
Was this helpful? React with 👍 or 👎 to provide feedback.
2 participants
adding faq.md and llms.txt files for AEO optimization
Fixes #[insert GH or internal issue link(s)].
Describe your change...
A picture of a cute animal (not mandatory, but encouraged)