Skip to content

Add docs for promptless suggestions command#4

Open
InlinePizza wants to merge 1 commit into
mainfrom
docs/add-suggestions-command-docs
Open

Add docs for promptless suggestions command#4
InlinePizza wants to merge 1 commit into
mainfrom
docs/add-suggestions-command-docs

Conversation

@InlinePizza
Copy link
Copy Markdown
Contributor

Summary

  • Designs the promptless suggestions command for triaging docs updates from the terminal. List view shows status, remote, PR, page, trigger, and timestamp; --stat adds a git diff --stat-style per-file breakdown; --id <id> shows full detail.
  • Filters and statuses are grounded in the existing api.gopromptless.ai /organizations/{org_id}/doc_updates response shape — statuses are ready / pr_open / published / closed; filters mirror the dashboard's Status / Docs location / Trigger source / Labels / free-text controls.
  • Adds an index.md and commands.md modeled on the foo/docs style, since the existing docs/ only covered auth.
  • Documents that a Promptless API key is implicitly scoped to one organization, so no command takes an --org flag.

Test plan

  • Confirm the four documented statuses match what the dashboard renders.
  • Confirm the filter dimensions (--status, --location, --trigger, --label, --assignee, --page, --since, --until, -q) cover every dashboard filter without over-promising.
  • Confirm the response fields named in the JSON section (pr_status, closed_at, impacted_files, trigger_events, collection_name, docs_platform, last_sha, etc.) match the /organizations/{org_id}/doc_updates payload.
  • Confirm the per-suggestion diff endpoint used by --stat (/organizations/{org_id}/change-history/{id}/diff) is the right route, or update the doc with the actual one before implementation.
  • Sanity-check the relative links between index.md, commands.md, suggestions.md, and the existing configuration.md / environment-variables.md / cli-auth-protocol.md.

🤖 Generated with Claude Code

Designs the `promptless suggestions` command for triaging docs updates
from the terminal. Grounded in the existing
api.gopromptless.ai/organizations/{org_id}/doc_updates response shape:
real statuses (ready / pr_open / published / closed), real filter
dimensions (location, trigger, label, assignee, free-text), and a
`--stat` flag that fetches per-suggestion diffs to render
git-diff-style line counts.

Also adds an index and command-reference page modeled on the
foo/docs structure, since the existing docs/ only covered auth.
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.

1 participant