Add agent-skill to installation pages and llms.txt#65
Closed
flySewa wants to merge 17 commits intoopen-circle:mainfrom
Closed
Add agent-skill to installation pages and llms.txt#65flySewa wants to merge 17 commits intoopen-circle:mainfrom
flySewa wants to merge 17 commits intoopen-circle:mainfrom
Conversation
|
@flySewa is attempting to deploy a commit to the Open Circle Team on Vercel. A member of the Team first needs to authorize it. |
dosubot
bot
added
the
size:M
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughAdds a "For AI Agents" subsection to installation guides and an Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 16
🧹 Nitpick comments (3)
website/src/routes/(docs)/react/guides/(get-started)/llms-txt/index.mdx (1)
27-27: Pin the externalagent-skilllink to an immutable revision.Line 27 links to
blob/main, which can drift as that repo changes. Prefer a permalink to a specific commit (or version tag) so this docs page stays stable over time.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@website/src/routes/`(docs)/react/guides/(get-started)/llms-txt/index.mdx at line 27, Replace the unstable GitHub blob/main link used by the `agent-skill` Markdown link with a permalink to a specific commit SHA or release tag so the referenced SKILL.md is immutable; locate the `agent-skill` link in the LLMS TXT guide (the markdown link text `agent-skill`) and update its URL from .../blob/main/... to .../blob/<commit-sha>/... or .../releases/tag/<tag>/... ensuring the link continues to point to the same SKILL.md file.website/src/routes/(docs)/vue/guides/(get-started)/llms-txt/index.mdx (1)
27-27: Clarify that this is an external resource, not an LLMs.txt route.This list is introduced as “Available routes,” but this entry points to an external GitHub document. Please label it as external (or move it under a separate “Resources” subsection) to avoid confusion.
Proposed wording tweak
-- [`agent-skill`](https://github.com/open-circle/agent-skills/blob/main/skills/formisch/SKILL.md) contains specialized instructions for AI agents to build forms and manage state. +- [`agent-skill` (external)](https://github.com/open-circle/agent-skills/blob/main/skills/formisch/SKILL.md) contains specialized instructions for AI agents to build forms and manage state.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@website/src/routes/`(docs)/vue/guides/(get-started)/llms-txt/index.mdx at line 27, The "Available routes" entry that currently reads with the link `[`agent-skill`](https://github.com/open-circle/agent-skills/blob/main/skills/formisch/SKILL.md)` points to an external GitHub doc and should be clearly marked as external (or moved out of the "Available routes" list into a new "Resources" subsection). Edit the markdown line referencing `agent-skill` to either prepend/apply an “(external)” label (e.g., "agent-skill (external)") or relocate that bullet under a new "Resources" heading so readers aren’t misled into thinking it is an internal LLMs.txt route.website/src/routes/(docs)/solid/guides/(get-started)/llms-txt/index.mdx (1)
27-27: Nit: trailing period is inconsistent with other list items.Lines 22–26 have no trailing period; line 27 does.
✏️ Proposed fix
-- [`agent-skill`](https://github.com/open-circle/agent-skills/blob/main/skills/formisch/SKILL.md) contains specialized instructions for AI agents to build forms and manage state. +- [`agent-skill`](https://github.com/open-circle/agent-skills/blob/main/skills/formisch/SKILL.md) contains specialized instructions for AI agents to build forms and manage state🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@website/src/routes/`(docs)/solid/guides/(get-started)/llms-txt/index.mdx at line 27, Remove the trailing period from the list item text "[`agent-skill`](https://github.com/open-circle/agent-skills/blob/main/skills/formisch/SKILL.md) contains specialized instructions for AI agents to build forms and manage state." so it matches the punctuation style of the other bullet items; edit the string in the MDX file (the list item containing the agent-skill link) to end without a period.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In
`@website/src/routes/`(docs)/preact/guides/(get-started)/installation/index.mdx:
- Around line 57-66: Run Prettier to fix formatting errors reported by CI: run
"prettier --write" across the changed files (including the MDX with the "For AI
Agents" section and the code block containing "npx skills add
open-circle/agent-skills"), re-check that the code block and surrounding
Markdown/MDX are properly formatted, then stage and commit the updated file(s)
so the CI style check passes.
- Around line 62-65: The two CLI lines ("npx skills add
open-circle/agent-skills" and "npx add-skill open-circle/agent-skills") are
alternatives, not commands to run sequentially; update the snippet in index.mdx
to make that explicit by either adding inline comments to each line (e.g.,
append " # using the skills CLI" to "npx skills add open-circle/agent-skills"
and " # using the add-skill CLI" to "npx add-skill open-circle/agent-skills") or
split them into two separate bash blocks with a short sentence between
explaining they are equivalent alternatives.
In `@website/src/routes/`(docs)/preact/guides/(get-started)/llms-txt/index.mdx:
- Line 27: The markdown link labeled `agent-skill` points to a dead URL
`https://github.com/open-circle/agent-skills/blob/main/skills/formisch/SKILL.md`;
update or remove it in the `index.mdx` content: either replace the broken URL
with a valid/working resource (or a new repo/path) or delete the link (and
optionally replace with plain text like "agent-skill" or remove the whole
sentence) so the page no longer references the 404 target.
- Line 27: The external GitHub link labeled `agent-skill` was incorrectly placed
under the "Available routes" list, uses a non-conforming label, and includes a
trailing period; move that link out of the "Available routes" section into a new
section header (e.g., "## Agent Skills" or "## For AI Agents"), change the link
label to follow the site's convention (use the actual resource identifier as
inline code, e.g., `agent-skill` or the relevant path if one exists), and remove
the trailing period from the description so formatting matches the other list
items.
In `@website/src/routes/`(docs)/qwik/guides/(get-started)/installation/index.mdx:
- Line 66: Replace the duplicated link text "[Learn Learn]" with a proper CTA
(e.g., "[Learn]" or "[Learn more]") so the Markdown reads something like "[Learn
more](https://github.com/open-circle/agent-skills) about the formisch skill";
locate the link text "[Learn Learn]" in the MDX and update it to the chosen
single-word or phrase CTA.
- Line 60: Reflow the long prose sentence "Formisch includes an agent skill that
teaches AI agents the correct patterns for working with Formisch forms. You can
install it by running the following command in your terminal:" into shorter
lines to satisfy Prettier (wrap to ~80 characters), preserving the exact wording
and punctuation; update the paragraph in index.mdx so the sentence is split
across multiple lines without altering content or adding markdown elements.
In `@website/src/routes/`(docs)/qwik/guides/(get-started)/llms-txt/index.mdx:
- Line 27: The new `agent-skill` link in
website/src/routes/(docs)/qwik/guides/(get-started)/llms-txt/index.mdx is
miscategorized under the "Available routes" (LLMs.txt routes) section; move the
entry out of that list into a new subsection (e.g., "For AI Agents" or "Agent
Skills") or at minimum add a parenthetical clarifying it is an external skill
file, and change the link label from `agent-skill` to a consistent filename
label such as `SKILL.md` or the full path `skills/formisch/SKILL.md` so it no
longer appears as a site route.
- Line 27: Update the markdown link that currently points to
skills/formisch/SKILL.md so it targets the correct path
skills/formisch-usage/SKILL.md; specifically, replace the URL in the
[`agent-skill`](https://github.com/open-circle/agent-skills/blob/main/skills/formisch/SKILL.md)
link with
https://github.com/open-circle/agent-skills/blob/main/skills/formisch-usage/SKILL.md
so the [`agent-skill`] anchor references the correct repository file.
In `@website/src/routes/`(docs)/react/guides/(get-started)/installation/index.mdx:
- Around line 60-66: Update the docs block that currently shows two commands to
clarify they are alternative ways to install the agent skill (e.g., "Run one of
the following commands:"), capitalize "Formisch" in the link text ("about the
Formisch skill"), and run Prettier/formatting on the MDX so CI style checks
pass; the changes should be applied to the code block containing the two
commands ('npx skills add open-circle/agent-skills' and 'npx add-skill
open-circle/agent-skills') and the link text that currently reads "about the
formisch skill".
In `@website/src/routes/`(docs)/solid/guides/(get-started)/installation/index.mdx:
- Around line 57-66: Run Prettier to fix the failing style check for the MDX
update: run prettier --write on the file containing the "For AI Agents" section
so the code block (the npx skills add/open-circle commands) and surrounding MDX
are formatted correctly; ensure the fenced code block (```bash ... ```) and the
link "[Learn more](https://github.com/open-circle/agent-skills)" follow
Prettier's MDX formatting (including trailing newline) and commit the formatted
file to unblock CI.
- Line 66: Update the link text that currently reads "[Learn
more](https://github.com/open-circle/agent-skills) about the formisch skill." to
use proper product-name casing by changing "formisch" to "Formisch" so it reads
"about the Formisch skill"; locate this exact string in the document (in the
installation/index.mdx content) and adjust the displayed text only, preserving
the URL and surrounding punctuation.
- Around line 62-65: Clarify that the two lines are alternative installation
methods rather than steps: label `npx skills add open-circle/agent-skills` as
the Skills.sh workflow (skill management/registration) and `npx add-skill
open-circle/agent-skills` as the Vercel Labs/agent auto-detection workflow
(creates directory and scaffolds agent files), and add a one-line note telling
users to run only the command matching their chosen workflow; also update the
lowercase product name `formisch` to `Formisch` for consistency.
In `@website/src/routes/`(docs)/solid/guides/(get-started)/llms-txt/index.mdx:
- Line 27: The listed external link label "agent-skill" points to a 404 GitHub
URL
(https://github.com/open-circle/agent-skills/blob/main/skills/formisch/SKILL.md)
and also doesn't match the surrounding internal route entries; verify or correct
the URL (replace with the correct repo/path if available), otherwise remove the
entry; if you want to keep it as an external resource, move the "agent-skill"
entry into a new "External resources" section instead of the internal routes
list; also remove the trailing period after the entry so punctuation matches the
other list items.
In
`@website/src/routes/`(docs)/svelte/guides/(get-started)/installation/index.mdx:
- Around line 57-66: CI is flagging formatting in the "For AI Agents" section of
the MDX (the heading "For AI Agents" and the adjacent code block containing the
npx skill install commands); run Prettier (or your editor’s formatter) on this
MDX so the code fence, spacing, and line endings conform to the repo style, then
stage and commit the formatted file so CI passes.
- Line 66: The link text "formisch" in the markdown line "[Learn
more](https://github.com/open-circle/agent-skills) about the formisch skill." is
using inconsistent lowercase; update the visible link text to use the proper
product capitalization "Formisch" (change the trailing phrase to "about the
Formisch skill.") so it matches the rest of the page's usage of Formisch.
In `@website/src/routes/`(docs)/vue/guides/(get-started)/installation/index.mdx:
- Around line 60-66: Change the phrasing to indicate multiple/alternative
commands and capitalize "Formisch" in the link text: update the sentence that
currently says "the following command" to "one of the following commands" (or
"the following commands" if both must be run) and ensure the link text reads
"Formisch skill" instead of "formisch skill"; adjust the code block showing the
two commands (npx skills add open-circle/agent-skills and npx add-skill
open-circle/agent-skills) accordingly so it's clear these are alternatives or
both are required.
---
Nitpick comments:
In `@website/src/routes/`(docs)/react/guides/(get-started)/llms-txt/index.mdx:
- Line 27: Replace the unstable GitHub blob/main link used by the `agent-skill`
Markdown link with a permalink to a specific commit SHA or release tag so the
referenced SKILL.md is immutable; locate the `agent-skill` link in the LLMS TXT
guide (the markdown link text `agent-skill`) and update its URL from
.../blob/main/... to .../blob/<commit-sha>/... or .../releases/tag/<tag>/...
ensuring the link continues to point to the same SKILL.md file.
In `@website/src/routes/`(docs)/solid/guides/(get-started)/llms-txt/index.mdx:
- Line 27: Remove the trailing period from the list item text
"[`agent-skill`](https://github.com/open-circle/agent-skills/blob/main/skills/formisch/SKILL.md)
contains specialized instructions for AI agents to build forms and manage
state." so it matches the punctuation style of the other bullet items; edit the
string in the MDX file (the list item containing the agent-skill link) to end
without a period.
In `@website/src/routes/`(docs)/vue/guides/(get-started)/llms-txt/index.mdx:
- Line 27: The "Available routes" entry that currently reads with the link
`[`agent-skill`](https://github.com/open-circle/agent-skills/blob/main/skills/formisch/SKILL.md)`
points to an external GitHub doc and should be clearly marked as external (or
moved out of the "Available routes" list into a new "Resources" subsection).
Edit the markdown line referencing `agent-skill` to either prepend/apply an
“(external)” label (e.g., "agent-skill (external)") or relocate that bullet
under a new "Resources" heading so readers aren’t misled into thinking it is an
internal LLMs.txt route.
ℹ️ Review info
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (12)
website/src/routes/(docs)/preact/guides/(get-started)/installation/index.mdxwebsite/src/routes/(docs)/preact/guides/(get-started)/llms-txt/index.mdxwebsite/src/routes/(docs)/qwik/guides/(get-started)/installation/index.mdxwebsite/src/routes/(docs)/qwik/guides/(get-started)/llms-txt/index.mdxwebsite/src/routes/(docs)/react/guides/(get-started)/installation/index.mdxwebsite/src/routes/(docs)/react/guides/(get-started)/llms-txt/index.mdxwebsite/src/routes/(docs)/solid/guides/(get-started)/installation/index.mdxwebsite/src/routes/(docs)/solid/guides/(get-started)/llms-txt/index.mdxwebsite/src/routes/(docs)/svelte/guides/(get-started)/installation/index.mdxwebsite/src/routes/(docs)/svelte/guides/(get-started)/llms-txt/index.mdxwebsite/src/routes/(docs)/vue/guides/(get-started)/installation/index.mdxwebsite/src/routes/(docs)/vue/guides/(get-started)/llms-txt/index.mdx
website/src/routes/(docs)/preact/guides/(get-started)/installation/index.mdx
Outdated
Show resolved
Hide resolved
Comment on lines
+62
to
+65
| ```bash | ||
| npx skills add open-circle/agent-skills | ||
| npx add-skill open-circle/agent-skills | ||
| ``` |
There was a problem hiding this comment.
Clarify whether these commands are alternatives or must both be run.
npx skills add and npx add-skill are two separate CLI tools, both capable of installing agent skills from a GitHub repo. Placing them together in a single code block without comments implies the user should run both sequentially, but they are actually equivalent alternatives.
This is also inconsistent with the file's existing convention, where each command line in a bash block carries an inline comment (e.g., # npm, # yarn) to explain its purpose. Either add inline comments to make the intent explicit, or split them into two blocks with prose in between.
✏️ Suggested clarification
```bash
-npx skills add open-circle/agent-skills
-npx add-skill open-circle/agent-skills
+npx skills add open-circle/agent-skills # using the skills CLI
+# or
+npx add-skill open-circle/agent-skills # using the add-skill CLI</details>
<!-- suggestion_start -->
<details>
<summary>📝 Committable suggestion</summary>
> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
```suggestion
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@website/src/routes/`(docs)/preact/guides/(get-started)/installation/index.mdx
around lines 62 - 65, The two CLI lines ("npx skills add
open-circle/agent-skills" and "npx add-skill open-circle/agent-skills") are
alternatives, not commands to run sequentially; update the snippet in index.mdx
to make that explicit by either adding inline comments to each line (e.g.,
append " # using the skills CLI" to "npx skills add open-circle/agent-skills"
and " # using the add-skill CLI" to "npx add-skill open-circle/agent-skills") or
split them into two separate bash blocks with a short sentence between
explaining they are equivalent alternatives.
| - [`llms-preact-full.txt`](/llms-preact-full.txt) contains the Markdown content of the entire Preact docs | ||
| - [`llms-preact-guides.txt`](/llms-preact-guides.txt) contains the Markdown content of the Preact guides | ||
| - [`llms-preact-api.txt`](/llms-preact-api.txt) contains the Markdown content of the Preact API reference | ||
| - [`agent-skill`](https://github.com/open-circle/agent-skills/blob/main/skills/formisch/SKILL.md) contains specialized instructions for AI agents to build forms and manage state. |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Verify the agent-skill GitHub URL returns HTTP 200
curl -o /dev/null -s -w "%{http_code}\n" \
"https://github.com/open-circle/agent-skills/blob/main/skills/formisch/SKILL.md"Repository: open-circle/formisch
Length of output: 67
Remove or replace the broken GitHub link.
The URL https://github.com/open-circle/agent-skills/blob/main/skills/formisch/SKILL.md returns HTTP 404 and does not exist. Either update the link to a valid resource or remove the reference before publication.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@website/src/routes/`(docs)/preact/guides/(get-started)/llms-txt/index.mdx at
line 27, The markdown link labeled `agent-skill` points to a dead URL
`https://github.com/open-circle/agent-skills/blob/main/skills/formisch/SKILL.md`;
update or remove it in the `index.mdx` content: either replace the broken URL
with a valid/working resource (or a new repo/path) or delete the link (and
optionally replace with plain text like "agent-skill" or remove the whole
sentence) so the page no longer references the 404 target.
External link doesn't belong under "Available routes" and has formatting inconsistencies.
Three issues with this entry:
-
Section mismatch: The "Available routes" section describes internal site routes (e.g.,
/llms.txt,/llms-preact.txt). This entry is an external GitHub link, not a route. Consider moving it to a new section (e.g.,## For AI Agentsor## Agent Skills) to avoid misleading users. -
Label style: All other list items use the literal route path as the link label (e.g.,
`llms.txt`,`llms-preact.txt`).agent-skillis a descriptive name, not a path — breaking the established convention. If kept in this section, the label should reflect the actual resource identifier. -
Trailing period: All other descriptions omit a trailing period; this one adds one. Keep consistent.
✏️ Proposed fix (separate section, consistent style)
-## Available routes
+## Available routes
We provide several LLMs.txt routes. Use the route that works best with your AI tool.
- [`llms.txt`](/llms.txt) contains a table of contents with links to all Markdown files
- [`llms-preact.txt`](/llms-preact.txt) contains a table of contents with links to Preact related files
- [`llms-preact-full.txt`](/llms-preact-full.txt) contains the Markdown content of the entire Preact docs
- [`llms-preact-guides.txt`](/llms-preact-guides.txt) contains the Markdown content of the Preact guides
- [`llms-preact-api.txt`](/llms-preact-api.txt) contains the Markdown content of the Preact API reference
-- [`agent-skill`](https://github.com/open-circle/agent-skills/blob/main/skills/formisch/SKILL.md) contains specialized instructions for AI agents to build forms and manage state.
+
+## For AI Agents
+
+- [`SKILL.md`](https://github.com/open-circle/agent-skills/blob/main/skills/formisch/SKILL.md) contains specialized instructions for AI agents to build forms and manage state📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| - [`agent-skill`](https://github.com/open-circle/agent-skills/blob/main/skills/formisch/SKILL.md) contains specialized instructions for AI agents to build forms and manage state. | |
| ## Available routes | |
| We provide several LLMs.txt routes. Use the route that works best with your AI tool. | |
| - [`llms.txt`](/llms.txt) contains a table of contents with links to all Markdown files | |
| - [`llms-preact.txt`](/llms-preact.txt) contains a table of contents with links to Preact related files | |
| - [`llms-preact-full.txt`](/llms-preact-full.txt) contains the Markdown content of the entire Preact docs | |
| - [`llms-preact-guides.txt`](/llms-preact-guides.txt) contains the Markdown content of the Preact guides | |
| - [`llms-preact-api.txt`](/llms-preact-api.txt) contains the Markdown content of the Preact API reference | |
| ## For AI Agents | |
| - [`SKILL.md`](https://github.com/open-circle/agent-skills/blob/main/skills/formisch/SKILL.md) contains specialized instructions for AI agents to build forms and manage state |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@website/src/routes/`(docs)/preact/guides/(get-started)/llms-txt/index.mdx at
line 27, The external GitHub link labeled `agent-skill` was incorrectly placed
under the "Available routes" list, uses a non-conforming label, and includes a
trailing period; move that link out of the "Available routes" section into a new
section header (e.g., "## Agent Skills" or "## For AI Agents"), change the link
label to follow the site's convention (use the actual resource identifier as
inline code, e.g., `agent-skill` or the relevant path if one exists), and remove
the trailing period from the description so formatting matches the other list
items.
website/src/routes/(docs)/qwik/guides/(get-started)/installation/index.mdx
Outdated
Show resolved
Hide resolved
website/src/routes/(docs)/qwik/guides/(get-started)/installation/index.mdx
Outdated
Show resolved
Hide resolved
website/src/routes/(docs)/solid/guides/(get-started)/installation/index.mdx
Outdated
Show resolved
Hide resolved
| - [`llms-solid-full.txt`](/llms-solid-full.txt) contains the Markdown content of the entire SolidJS docs | ||
| - [`llms-solid-guides.txt`](/llms-solid-guides.txt) contains the Markdown content of the SolidJS guides | ||
| - [`llms-solid-api.txt`](/llms-solid-api.txt) contains the Markdown content of the SolidJS API reference | ||
| - [`agent-skill`](https://github.com/open-circle/agent-skills/blob/main/skills/formisch/SKILL.md) contains specialized instructions for AI agents to build forms and manage state. |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# Check if the GitHub URL is reachable
curl -I -s -w "\nHTTP Status: %{http_code}\n" \
"https://github.com/open-circle/agent-skills/blob/main/skills/formisch/SKILL.md"Repository: open-circle/formisch
Length of output: 4974
🏁 Script executed:
# Read the file to examine the context around line 27
cat -n website/src/routes/'(docs)'/solid/guides/'(get-started)'/llms-txt/index.mdx | sed -n '20,35p'Repository: open-circle/formisch
Length of output: 1295
🏁 Script executed:
# Also check if the file exists and get its general structure
wc -l website/src/routes/'(docs)'/solid/guides/'(get-started)'/llms-txt/index.mdxRepository: open-circle/formisch
Length of output: 138
This pull request adds a broken link — the GitHub URL returns 404.
The URL https://github.com/open-circle/agent-skills/blob/main/skills/formisch/SKILL.md is inaccessible (HTTP 404). Either the repository path is incorrect or the file does not exist; this must be verified and corrected before merging.
Additionally, this entry does not fit the section context. Lines 22–26 list internal site routes using their paths as labels (e.g., /llms.txt), but line 27 adds an external GitHub resource with a generic label (agent-skill). Consider either moving this to a separate "External resources" section or removing it entirely if the URL cannot be verified.
Minor: Line 27 is the only entry with a trailing period; remove it for consistency with lines 22–26.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@website/src/routes/`(docs)/solid/guides/(get-started)/llms-txt/index.mdx at
line 27, The listed external link label "agent-skill" points to a 404 GitHub URL
(https://github.com/open-circle/agent-skills/blob/main/skills/formisch/SKILL.md)
and also doesn't match the surrounding internal route entries; verify or correct
the URL (replace with the correct repo/path if available), otherwise remove the
entry; if you want to keep it as an external resource, move the "agent-skill"
entry into a new "External resources" section instead of the internal routes
list; also remove the trailing period after the entry so punctuation matches the
other list items.
Comment on lines
+57
to
+66
|
|
||
| ## For AI Agents | ||
|
|
||
| Formisch includes an agent skill that teaches AI agents the correct patterns for working with Formisch forms. You can install it by running the following command in your terminal: | ||
|
|
||
| ```bash | ||
| npx skills add open-circle/agent-skills | ||
| npx add-skill open-circle/agent-skills | ||
| ``` | ||
| [Learn more](https://github.com/open-circle/agent-skills) about the formisch skill. No newline at end of file |
There was a problem hiding this comment.
Resolve the CI style warning before merge.
The pipeline reports formatting issues; please run Prettier on this file so CI passes cleanly.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@website/src/routes/`(docs)/svelte/guides/(get-started)/installation/index.mdx
around lines 57 - 66, CI is flagging formatting in the "For AI Agents" section
of the MDX (the heading "For AI Agents" and the adjacent code block containing
the npx skill install commands); run Prettier (or your editor’s formatter) on
this MDX so the code fence, spacing, and line endings conform to the repo style,
then stage and commit the formatted file so CI passes.
website/src/routes/(docs)/svelte/guides/(get-started)/installation/index.mdx
Outdated
Show resolved
Hide resolved
website/src/routes/(docs)/vue/guides/(get-started)/installation/index.mdx
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In
`@website/src/routes/`(docs)/preact/guides/(get-started)/installation/index.mdx:
- Line 67: The documentation uses lowercase "formisch" in the link text "[Learn
more](https://github.com/open-circle/agent-skills) about the formisch skill.";
update that text to use the consistent product casing "Formisch" (e.g., "about
the Formisch skill") so the link label and surrounding copy match the rest of
the docs.
In `@website/src/routes/`(docs)/qwik/guides/(get-started)/installation/index.mdx:
- Around line 62-65: The two CLI commands shown (npx skills add
open-circle/agent-skills and npx add-skill open-circle/agent-skills) are
alternatives, not steps; update the MDX so it clearly indicates they are
mutually exclusive by either splitting them into separate fenced code blocks
with a brief inline comment (e.g., “# using the skills CLI” and “# using the
add-skill CLI”) or adding a short sentence above the block that says “Choose one
of the following commands.” Locate the occurrences of the exact command strings
in the document and apply the clarification.
ℹ️ Review info
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
website/src/routes/(docs)/preact/guides/(get-started)/installation/index.mdxwebsite/src/routes/(docs)/qwik/guides/(get-started)/installation/index.mdxwebsite/src/routes/(docs)/react/guides/(get-started)/installation/index.mdxwebsite/src/routes/(docs)/solid/guides/(get-started)/installation/index.mdxwebsite/src/routes/(docs)/svelte/guides/(get-started)/installation/index.mdxwebsite/src/routes/(docs)/vue/guides/(get-started)/installation/index.mdx
🚧 Files skipped from review as they are similar to previous changes (3)
- website/src/routes/(docs)/react/guides/(get-started)/installation/index.mdx
- website/src/routes/(docs)/vue/guides/(get-started)/installation/index.mdx
- website/src/routes/(docs)/svelte/guides/(get-started)/installation/index.mdx
website/src/routes/(docs)/preact/guides/(get-started)/installation/index.mdx
Outdated
Show resolved
Hide resolved
Comment on lines
+62
to
+65
| ```bash | ||
| npx skills add open-circle/agent-skills | ||
| npx add-skill open-circle/agent-skills | ||
| ``` |
There was a problem hiding this comment.
Clarify that these commands are alternatives, not sequential steps.
npx skills add (Skills.sh CLI) and npx add-skill (Vercel Labs tool) are two different tools that both install agent skills. Listing them together without explanation implies users should run both sequentially. Add inline comments or split into separate blocks to indicate they are alternatives.
✏️ Suggested clarification
```bash
-npx skills add open-circle/agent-skills
-npx add-skill open-circle/agent-skills
+npx skills add open-circle/agent-skills # using the skills CLI
+# or
+npx add-skill open-circle/agent-skills # using the add-skill CLI</details>
<!-- suggestion_start -->
<details>
<summary>📝 Committable suggestion</summary>
> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
```suggestion
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@website/src/routes/`(docs)/qwik/guides/(get-started)/installation/index.mdx
around lines 62 - 65, The two CLI commands shown (npx skills add
open-circle/agent-skills and npx add-skill open-circle/agent-skills) are
alternatives, not steps; update the MDX so it clearly indicates they are
mutually exclusive by either splitting them into separate fenced code blocks
with a brief inline comment (e.g., “# using the skills CLI” and “# using the
add-skill CLI”) or adding a short sentence above the block that says “Choose one
of the following commands.” Locate the occurrences of the exact command strings
in the document and apply the clarification.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
website/src/routes/(docs)/vue/guides/(get-started)/llms-txt/index.mdx (1)
30-30: Consider linking to a stable revision instead ofmain.Using
blob/maincan drift over time. Prefer a tag or commit-pinned URL so docs remain reproducible.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@website/src/routes/`(docs)/vue/guides/(get-started)/llms-txt/index.mdx at line 30, The link currently points to the mutable branch reference `blob/main` for `SKILL.md`; update the URL to a stable revision by replacing `blob/main` with a tag or commit SHA (e.g., `blob/<tag-or-commit>`), so the `SKILL.md` link in the document points to a reproducible, pinned version instead of the moving `main` branch.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@website/src/routes/`(docs)/vue/guides/(get-started)/llms-txt/index.mdx:
- Around line 28-31: Remove the trailing whitespace after the "## For AI Agents"
heading and remove the extra leading indentation before the SKILL.md link text
so the link line is left-aligned directly under the paragraph; locate the "##
For AI Agents" heading and the SKILL.md link (the text "`SKILL.md`" / URL to
agent-skills) in the llms-txt/index.mdx content and adjust spacing so there is
no trailing space on the heading line and the link line starts at column 1 with
normal single-space indentation for a markdown paragraph.
---
Nitpick comments:
In `@website/src/routes/`(docs)/vue/guides/(get-started)/llms-txt/index.mdx:
- Line 30: The link currently points to the mutable branch reference `blob/main`
for `SKILL.md`; update the URL to a stable revision by replacing `blob/main`
with a tag or commit SHA (e.g., `blob/<tag-or-commit>`), so the `SKILL.md` link
in the document points to a reproducible, pinned version instead of the moving
`main` branch.
Comment on lines
+28
to
+31
| ## For AI Agents | ||
|
|
||
| [`SKILL.md`](https://github.com/open-circle/agent-skills/blob/main/skills/formisch/SKILL.md) contains specialized instructions for AI agents to build forms and manage state | ||
|
|
There was a problem hiding this comment.
Fix Markdown formatting to unblock CI.
Prettier is failing on this section. On Line 28 there’s trailing whitespace, and on Line 30 there’s extra leading indentation before the link text.
Proposed formatting fix
-## For AI Agents
-
- [`SKILL.md`](https://github.com/open-circle/agent-skills/blob/main/skills/formisch/SKILL.md) contains specialized instructions for AI agents to build forms and manage state
+## For AI Agents
+
+[`SKILL.md`](https://github.com/open-circle/agent-skills/blob/main/skills/formisch/SKILL.md) contains specialized instructions for AI agents to build forms and manage state.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| ## For AI Agents | |
| [`SKILL.md`](https://github.com/open-circle/agent-skills/blob/main/skills/formisch/SKILL.md) contains specialized instructions for AI agents to build forms and manage state | |
| ## For AI Agents | |
| [`SKILL.md`](https://github.com/open-circle/agent-skills/blob/main/skills/formisch/SKILL.md) contains specialized instructions for AI agents to build forms and manage state. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@website/src/routes/`(docs)/vue/guides/(get-started)/llms-txt/index.mdx around
lines 28 - 31, Remove the trailing whitespace after the "## For AI Agents"
heading and remove the extra leading indentation before the SKILL.md link text
so the link line is left-aligned directly under the paragraph; locate the "##
For AI Agents" heading and the SKILL.md link (the text "`SKILL.md`" / URL to
agent-skills) in the llms-txt/index.mdx content and adjust spacing so there is
no trailing space on the heading line and the link line starts at column 1 with
normal single-space indentation for a markdown paragraph.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit