Adding some AI hints to our documentation
Alex Norman

Alex Norman @alexander_

About: Posting because I have to

Joined:
May 29, 2025

Adding some AI hints to our documentation

Publish Date: Aug 7
6 1

In the previous post Front up with front matter, I briefly touched on the request of asking AI to offer suggestions to improve SEO and enhance how AI chat bots reference and utilise our documentation.

The next round of updates relate to making it easier for our customers to directly ingest our documentation into their AI chats.

AI hints on our docs

Open with ChatGPT

This one was interesting. I've seen this done before, but it turned out to be less obvious than originally dreamed.

As usual, Cursor provided most of the scaffolding to get a basic integration to send data to OpenAI's ChatGPT. What I didn't bother looking up at the start was whether this can be done and how it would work.

With ChatGPT, you can send through the chat prompt in the URL as a parameter. With the parameter in the URL, you're restricted by some character types, length, and potentially being blocked by WAFs. What ended up working looked like

https://chat.openai.com/?q=Can%20you%20summarize%20this%20page%3A%20https%3A%2F%2Fdocs.kinde.com%2Fget-started%2Fguides%2Ffirst-things-first%2F
Enter fullscreen mode Exit fullscreen mode

ChatGPT prompt

This basically opens up ChatGPT and pre-writes the prompt to Can you summarize this page https://docs.kinde.com/get-started/guides/first-things-first/. Now when you chat about the documentation, it'll already have the context pre-loaded.

Open with other LLMs

What I didn't know was that you can't do the URL parameter trick for other LLMs, such as Claude or Gemini. Neither support this type of pre-written prompt. Honestly I'd say that this is a security feature since you could potentially inject malicious information to a prompt via a link.

I asked both Claude and Gemini for their own guidance and was pointed to their APIs and other deeper integrations, which are too time consuming for this exercise. So in the end, only ChatGPT gets a mention.

Copy for AI

The next part is something I've seen in a lot of documentation sites. Here's an example of what Stripe has on their documentation.

Stripe example

The copy for AI button basically takes the content of the page in markdown and copies it to your clipboard. You can then paste it into whatever LLM or AI service you're using. I guess the irony is that you can simply paste the page URL into the AI chat to get the content, so this method might save you a few tokens by not having to browse the internet for the content.

Metrics

And lastly, it's important (more a curiosity) to know if anyone is using these features. We're a big user of Plausible for our web analytics. Plausible supports custom event goals to help track when certain things happen on your site. For both the Open with ChatGPT and Copy for AI buttons, we attached a custom event that's recorded with Plausible. This way we can figure out whether this is a quality of life feature worth expanding or if it dies a slow death here.

Once the custom events are being ingested, you can create dashboard filters for them to see usage.

Plausible filtering for custom events

Summary

As part of the continuing AI-ification for our documentation, I think this is a decent practical example of helping customers and users quickly add context to their existing AI chat sessions. I'm sure there will be more to follow.

Comments 1 total

  • Luna Breeze
    Luna BreezeAug 11, 2025

    Interesting perspective on why many developers skip proper planning. It’s true that the pressure to start coding quickly often leads to overlooked architecture and missed optimization opportunities. For students and professionals working on academic projects, using resources like the Vit GPA chart can help track progress and manage goals alongside technical planning. Combining structured project outlines with measurable milestones ensures both efficiency and long-term success.

Add comment