Skip to content

Conversation

ethanpalm
Copy link
Collaborator

@ethanpalm ethanpalm commented Sep 26, 2025

Documentation changes

This PR documents the agent.

Closes https://linear.app/mintlify/issue/DOC-41/writer-launch-docs


For Reviewers

When reviewing documentation PRs, please consider:

✅ Technical accuracy

  • Code examples work as written
  • Commands and configurations are correct
  • Links resolve to the right destinations
  • Prerequisites and requirements are accurate

✅ Clarity and completeness

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed
  • Error messages or troubleshooting guidance is helpful

Note

Adds Agent documentation and API reference (create/get jobs), updates Slack app docs, updates navigation, and extends OpenAPI with Agent endpoints.

  • Docs:
    • Agent: New page ai/agent.mdx covering setup via Slack, repo access, API usage, prompting guidance, and workflows.
    • Slack app: Clarifies bot name to @yourprojectname-assistant, updates setup heading and test steps in ai/slack-app.mdx.
  • API Reference:
    • Adds Agent endpoints pages: api-reference/agent/create-agent-job, .../get-agent-job, .../get-all-jobs.
    • Navigation updates in docs.json: adds ai/agent under AI optimization and an Agent group under API Reference with the 3 pages.
  • OpenAPI:
    • Extends discovery-openapi.json with /agent/job/{domain} (POST), /agent/{domain}/job/{id} (GET), and /agent/{domain}/jobs (GET) schemas and responses.
  • Linting:
    • Adds Slack to .vale/styles/Google/Headings.yml exceptions.

Written by Cursor Bugbot for commit c6a2c0e. This will update automatically on new commits. Configure here.

cursor[bot]

This comment was marked as outdated.

@ethanpalm ethanpalm marked this pull request as draft September 26, 2025 21:56
@cdxker cdxker merged commit 09d28cb into main Sep 29, 2025
6 checks passed
@cdxker cdxker deleted the agent-docs branch September 29, 2025 06:46
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