chore(agents): add Docs Feedback Protocol section to AGENTS.md#386
chore(agents): add Docs Feedback Protocol section to AGENTS.md#386mstopa wants to merge 2 commits into
Conversation
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>
|
Important Review skippedReview was skipped due to path filters ⛔ Files ignored due to path filters (1)
CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
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.
|
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 If you'd like reports to actually reach you as issues, here's the one-time setup:
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 |
|
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. |
Pull Request
What does this PR do?
Adds a
## Documentation feedbacksection to.github/AGENTS.mdso 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 theAGENTS.mdblock. 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
chore(agents): agent instructions / repo configChecklist
AGENTS.mdchangemarkdownlintclean 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.