From dafde6af9b3cf37e289f98ae9ccb374ca4ab065c Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 6 Mar 2026 08:18:00 +0000 Subject: [PATCH 1/3] Initial plan From 3cee91c33307d68f59aebc4df68672f1c86e192e Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 6 Mar 2026 08:19:57 +0000 Subject: [PATCH 2/3] docs: add AI-assisted development usage guidance to README Co-authored-by: dogenkigen <2345634+dogenkigen@users.noreply.github.com> --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index fef3461..7e31496 100644 --- a/README.md +++ b/README.md @@ -204,6 +204,17 @@ Instead of integrating DocAssert into your tests, you can also use it as a stand doc-assert --url http://localhost:8081 --variables '{"auth_token": "some_token"}' README.md ``` +### Using DocAssert for AI-assisted development + +DocAssert is a good fit for AI-assisted workflows where an agent updates API docs and code in the same task. +After AI-generated changes, run DocAssert to verify that examples in your `README.md` still match real API behavior. + +It can also be included in AI "skills" or reusable task templates, for example: + +- add a step like `doc-assert --url http://localhost:8081 README.md` to your skill's verification checklist +- require DocAssert to pass before accepting AI-generated documentation updates +- run DocAssert in CI for PRs created by AI agents, so docs and API behavior stay aligned + ## Installation To use DocAssert as a CLI tool you can install it using cargo: From edf277f15814450e079f3f79db520cfadbf4e48c Mon Sep 17 00:00:00 2001 From: Maciej Laskowski Date: Fri, 6 Mar 2026 09:22:07 +0100 Subject: [PATCH 3/3] Enhance README with AI-assisted development context Added a note about AI-assisted development benefits. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 7e31496..0b87e12 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@ **DocAssert** is a documentation testing tool that offers a completely new approach. Write your documentation as a story you want to tell your users and test it against your API. +It can be really usefule for AI assited development when you want to provide more context for your agent. ## How it works?