Skip to content

Expand README with AI-assisted development integration guidance #54

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dogenkigen merged 4 commits into from
Mar 6, 2026
Merged

Expand README with AI-assisted development integration guidance #54

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dafde6a
Initial plan
Copilot Mar 6, 2026
3cee91c
docs: add AI-assisted development usage guidance to README
Copilot Mar 6, 2026
edf277f
Enhance README with AI-assisted development context
dogenkigen Mar 6, 2026
09449a1
Merge branch 'main' into copilot/update-readme-doc-assert
Mar 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand Down Expand Up @@ -204,6 +205,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:
Expand Down
Loading