Skip to content

docs: update AI section, skills, and add markdown-access and llms-txt pages#229

Merged
stefanjudis merged 12 commits intomainfrom
docs/ai-section-and-markdown-access
Mar 25, 2026
Merged

docs: update AI section, skills, and add markdown-access and llms-txt pages#229
stefanjudis merged 12 commits intomainfrom
docs/ai-section-and-markdown-access

Conversation

@stefanjudis
Copy link
Collaborator

Affected Components

  • Content & Marketing
  • Pricing
  • Test
  • Docs
  • Learn
  • Other

Notes for the Reviewer

  • Moves AI pages from integrations/ai/ to ai/, creating a standalone AI section in the sidebar
  • Adds new Markdown Access page documenting .md endpoints, content negotiation via Accept header, and the copy-as-markdown button
  • Adds new llms.txt page documenting the llms.txt index file with the first 15 lines as an example
  • Updates Skills page with revised install command (npx checkly skills install) and updated content
  • Updates agent-example.mdx snippet with revised card content
  • Updates all internal links across cli/, guides/, and snippets/ to use the new /ai/ paths

Move AI pages from integrations/ai/ to ai/, add new markdown-access
and llms-txt documentation pages, and update all internal links.
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR reorganizes and expands the docs’ AI section by moving AI content to a top-level /ai/ hierarchy, adding new AI-ingestion helper pages, and updating cross-references to the new paths.

Changes:

  • Creates a standalone AI section in the sidebar and updates internal links to use /ai/* routes.
  • Adds new docs pages for Markdown Access (.md endpoints + Accept: text/markdown) and llms.txt usage.
  • Updates Skills install instructions and refreshes agent example snippets/cards.

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
snippets/agent-example.mdx Updates the card prompts shown in AI agent examples.
guides/agentic-workflows.mdx Updates AI overview links to the new /ai/overview path.
docs.json Adds a top-level AI group and registers new AI pages in navigation.
cli/overview.mdx Updates cards linking to Skills/Rules to the new /ai/* paths.
cli/checkly-skills.mdx Updates Skills cross-link and adds install to the actions table.
ai/skills.mdx Revises install command and adjusts sidebar title for the AI section.
ai/rules.mdx Renames sidebar title and adds a warning recommending Skills when supported.
ai/overview.mdx Updates internal links and refines positioning text for agent workflows.
ai/markdown-access.mdx New page documenting .md endpoints, Accept negotiation, and “Copy as Markdown”.
ai/llms-txt.mdx New page documenting llms.txt and providing a sample excerpt + curl examples.
Comments suppressed due to low confidence (2)

ai/rules.mdx:11

  • Grammar: “your coding agents supports” is ungrammatical. Consider changing this to either “your coding agent supports …” (singular) or “your coding agents support …” (plural), and keep the sentence punctuation consistent with surrounding content.
    ai/skills.mdx:15
  • The text says the command can install skills “globally or in your project”, but npx checkly skills install installs the SKILL.md into a project directory per the CLI reference. Consider rewording to avoid implying a global install option unless there is one.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

stefanjudis and others added 5 commits March 25, 2026 21:07
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@mintlify
Copy link
Contributor

mintlify bot commented Mar 25, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
checkly-422f444a 🟢 Ready View Preview Mar 25, 2026, 8:09 PM

Copy link
Contributor

@guolau guolau left a comment

Choose a reason for hiding this comment

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

Left a few nits (I added them before I saw you were mostly reorganizing content). Leaving this review as a general comment instead of the others since these are mostly nice-to-have nits 🙂

The only important thing -- did we want to add redirects for the old URLs?

In docs.json, something like this:

{
  "source": "/integrations/ai/overview",
  "destination": "/ai/overview"
},
{
  "source": "/integrations/ai/rules",
  "destination": "/ai/rules"
},
{
  "source": "/integrations/ai/skills",
  "destination": "/ai/skills"
}, 


## Feeding documentation to AI assistants

Here are some patterns for using Checkly documentation with AI tools:
Copy link
Contributor

@guolau guolau Mar 25, 2026

Choose a reason for hiding this comment

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

Is this the best way to give agents context? I'd assume modern agents can query the URL directly, which might be easier than having to copy a page's MD? (Asking since I am mostly curious and not too familiar with how this stuff works 🙂)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Great call. removed rephrased. :)

Co-authored-by: Laura Guo <48332483+guolau@users.noreply.github.com>
Rephrase skills tip, simplify copy-as-markdown description,
and remove verbose AI assistant usage examples.
@stefanjudis stefanjudis merged commit ad1de5d into main Mar 25, 2026
3 checks passed
@stefanjudis stefanjudis deleted the docs/ai-section-and-markdown-access branch March 25, 2026 22:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants