Skip to content

Expand README with AI-assisted development integration guidance#54

Merged
dogenkigen merged 4 commits intomainfrom
copilot/update-readme-doc-assert
Mar 6, 2026
Merged

Expand README with AI-assisted development integration guidance#54
dogenkigen merged 4 commits intomainfrom
copilot/update-readme-doc-assert

Conversation

Copy link
Contributor

Copilot AI commented Mar 6, 2026

This updates the README to clarify how doc-assert fits into AI-assisted development workflows. It adds explicit guidance for using DocAssert in reusable AI skills/templates and CI gates for AI-generated documentation changes.

  • What was added

    • New README section: “Using DocAssert for AI-assisted development”
    • Guidance on validating AI-authored API docs against live endpoints before accepting changes
  • How to apply in AI workflows

    • Add DocAssert as a required verification step in skill/task templates
    • Gate acceptance of AI-generated documentation updates on DocAssert passing
    • Run DocAssert in CI on PRs generated or modified by AI agents
  • Example integration snippet

    doc-assert --url http://localhost:8081 README.md

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: dogenkigen <2345634+dogenkigen@users.noreply.github.com>
Copilot AI changed the title [WIP] Edit README to include doc-assert usage for AI development Expand README with AI-assisted development integration guidance Mar 6, 2026
Added a note about AI-assisted development benefits.
@dogenkigen dogenkigen marked this pull request as ready for review March 6, 2026 08:22
@dogenkigen dogenkigen merged commit f2838bd into main Mar 6, 2026
1 check failed
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.

2 participants