Add docs for promptless suggestions command#4
Open
InlinePizza wants to merge 1 commit into
Open
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
promptless suggestionscommand for triaging docs updates from the terminal. List view shows status, remote, PR, page, trigger, and timestamp;--statadds agit diff --stat-style per-file breakdown;--id <id>shows full detail.api.gopromptless.ai/organizations/{org_id}/doc_updatesresponse shape — statuses areready/pr_open/published/closed; filters mirror the dashboard's Status / Docs location / Trigger source / Labels / free-text controls.index.mdandcommands.mdmodeled on the foo/docs style, since the existingdocs/only covered auth.--orgflag.Test plan
--status,--location,--trigger,--label,--assignee,--page,--since,--until,-q) cover every dashboard filter without over-promising.pr_status,closed_at,impacted_files,trigger_events,collection_name,docs_platform,last_sha, etc.) match the/organizations/{org_id}/doc_updatespayload.--stat(/organizations/{org_id}/change-history/{id}/diff) is the right route, or update the doc with the actual one before implementation.index.md,commands.md,suggestions.md, and the existingconfiguration.md/environment-variables.md/cli-auth-protocol.md.🤖 Generated with Claude Code