[go: up one dir, main page]

Update agents.md docs

What does this MR do?

This MR uses Draft: docs: add AGENTS.md documentation (!216391) as a starting point to update the agents.md docs. I've applied most of the edits to this section from that MR and added a new section that introduces the two options and how they compare first. This is a first iteration, part of a larger plan we've outlined in this comment.

Preview link: https://docs.gitlab.com/upstream-review-mr-ee-216547/user/gitlab_duo_chat/agentic_chat/#customize-gitlab-duo-chat-in-your-ide

Note: I used Duo to help me pull in the edits from the original MR. I wanted it to pull in the changes, show me the changes in diff view for this file specifically, and then delete the changes to the other files on this branch after I'd resolved the conflicts. That's why the commit history looks a bit weird on this MR. I probably could have just cherry-picked the file but I really wanted to see the differences and apply edits one at a time. The commits will be squashed anyway when we merge this MR I ended up undoing this to fix the pipeline.

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Uma Chandran

Merge request reports

Loading