Skip to content

chore(agents): add Docs Feedback Protocol section to AGENTS.md#386

Open
mstopa wants to merge 2 commits into
macalbert:mainfrom
mstopa:docs/add-docs-feedback-protocol
Open

chore(agents): add Docs Feedback Protocol section to AGENTS.md#386
mstopa wants to merge 2 commits into
macalbert:mainfrom
mstopa:docs/add-docs-feedback-protocol

Conversation

@mstopa

@mstopa mstopa commented Jun 26, 2026

Copy link
Copy Markdown

Pull Request

What does this PR do?

Adds a ## Documentation feedback section to .github/AGENTS.md so agents of your contributors or users can offer to report broken / outdated / incomplete docs back to you as structured GitHub issues, via the open Docs Feedback Protocol. Zero new dependencies — just the AGENTS.md block. It's consent-gated: the agent only offers, shows you the draft, and sends nothing without confirmation.

Related issues

None — unsolicited contribution. Happy to close if it's not a fit.

Type of change

  • Feature
  • Bugfix
  • Refactor
  • Documentation
  • Other — chore(agents): agent instructions / repo config

Checklist

  • Tests added/updated (if needed) — n/a, no code changed (markdown-only)
  • Docs updated (if needed) — n/a, this PR is the AGENTS.md change
  • Lint/format pass — verified markdownlint clean against your .markdownlint.json (markdown-only change; Biome/tsc/secretlint n/a)

Notes for reviewer

The changes in this PR were drafted by an AI agent and human-reviewed by me. Close it with zero hard feelings if it's not your thing.

Lets agents working in this repo offer to report broken, outdated, or
incomplete docs back to the maintainer as structured GitHub issues via the
open Docs Feedback Protocol (https://docsfeedback.org). Opt-in and
consent-gated: the agent shows the draft and sends only on confirmation;
nothing is filed automatically.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Signed-off-by: mstopa <39024197+mstopa@users.noreply.github.com>
@mstopa mstopa requested a review from macalbert as a code owner June 26, 2026 20:13
@coderabbitai

coderabbitai Bot commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (1)
  • .github/AGENTS.md is excluded by none and included by none

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 7af220ef-2056-44c0-809c-f53ea40b5480

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Code Review

This pull request adds a "Documentation feedback" section to .github/AGENTS.md instructing AI agents on how to report broken or outdated documentation using the Docs Feedback Protocol. The reviewer suggested updating the doc_url placeholder to specify a fully qualified URL rather than a relative local path, ensuring that feedback reports can be correctly routed to the repository maintainers.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread .github/AGENTS.md
@mstopa

mstopa commented Jun 26, 2026

Copy link
Copy Markdown
Author

Hello @macalbert, and congratulations on how great you've instrumented this repo for agents. Can I interest you in one more way to automate your project maintenance? I've just started reaching out to repo owners, but I'm genuinely dedicated to building something useful, and I'd be grateful if you'd take a look.

FixYourDocs is an open protocol (spec: https://docsfeedback.org) for agent-to-human feedback. When an agent hits broken/outdated/missing content in your docs at https://envilder.com/docs, it sends a report to the Hub, and the Hub opens a new GitHub issue in your repo.

There's an MCP server + Python/TS SDKs, but the zero-dep path is just an AGENTS.md block, which is what this PR adds (to .github/AGENTS.md). I considered adding it as one of your skills instead, but that wouldn't load for contributors using Claude Code or Cursor.

If you'd like reports to actually reach you as issues, here's the one-time setup:

  1. Sign up at https://fixyourdocs.io (email/password or "Sign in with GitHub").
  2. Install the FixYourDocs GitHub App on macalbert/envilder.
  3. Claim your docs domain envilder.com via the DNS-TXT record the Hub shows you (no GitHub-Pages claim needed — your docs are on the custom domain).
  4. Point the integration at macalbert/envilder for issues.

Full disclosure: the changes in this PR were drafted by an AI agent and human-reviewed by me. Close it with zero hard feelings if it's not your thing. If you have opinions on the initiative or the protocol itself, I'd genuinely want to hear them — you're exactly who this project should answer to.

Spec: https://docsfeedback.org · Docs: https://docs.fixyourdocs.io

@macalbert

Copy link
Copy Markdown
Owner

Hey @mstopa, thanks a lot for this, and for the kind words about the repo. The initiative sounds interesting. I'll take a proper look at the PR and the spec and get back to you with my thoughts. Appreciate you reaching out.

@macalbert macalbert self-assigned this Jul 6, 2026
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