Restructure Console docs around harness, context, and workflows - #16
Open
ogael-amplify wants to merge 1 commit into
Open
Restructure Console docs around harness, context, and workflows#16ogael-amplify wants to merge 1 commit into
ogael-amplify wants to merge 1 commit into
Conversation
Organize the Amplify Console tab into three pillars that build on each other: the harness (the primitives you author), context (what it can see), and workflows (automating it). Adds a quickstart that walks all three in one pass. New sections: - The Harness — agents, the AGENT.md frontmatter reference, the built-in agent library, skills, detections, and a tool reference enumerating what agents can actually do - Context — projects, connections, what agents can read from a vendor connection, and findings - Working interactively — chat and the CLI, absorbing the chat material and web-vs-CLI comparison that previously lived in the introduction Workflows keeps its existing pages, with the agent catalog moved to harness/agent-library (it's a harness fact, not a workflow one) and a new page on what a run produces. workflows/agents is renamed to workflows/agent-chain, with a redirect. Capability boundaries are documented explicitly rather than omitted: vendor connections are readable only as vulnerability findings, web_fetch cannot write to third-party APIs, patch is the only artifact kind produced today, skills have no web editor, CodeQL detections are stored but not executed, and scheduled triggers do not exist yet. Also replaces the Mintlify starter-kit README, which documented the old mintlify CLI and mint.json instead of mint and docs.json. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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
Restructures the Amplify Console docs tab around three pillars that build on each other:
A new Quickstart walks all three in one pass: connect a repo → ask an agent → write an agent → automate it.
24 pages in the Console tab, 17 new or rewritten. The legacy tab is untouched.
Structure
introduction(rewritten),quickstart(new),install-consoleoverview,agents,writing-an-agent,agent-library,skills,detections,tool-referenceoverview,projects,connections,vendor-data,findingschat,clioverview,create-a-workflow,agent-chain,triggers,outputs,running,artifactsThe two load-bearing reference pages are
harness/writing-an-agent(the fullAGENT.mdYAML frontmatter schema, withdescriptioncalled out as functional rather than a comment — the workflow orchestrator reads it to brief each step) andharness/tool-reference(every tool an agent can call, which is the real ceiling on what any agent can do).Notable moves
workflows/agentstoharness/agent-library— which agents exist is a harness fact, not a workflow one.workflows/agents→workflows/agent-chain, now focused purely on execution semantics. Adocs.jsonredirect preserves existing links.introductioninto the new Working interactively group, so the introduction can lead with the thesis.Capability boundaries are documented, not omitted
Several places where the product's story outruns what ships today are called out explicitly in
<Warning>/<Note>callouts rather than left ambiguous:context/vendor-datacarries an explicit "cannot" list.web_fetchis read-only (no request method or body), so there is no path for an agent to write to a third-party API. Outbound writes go through workflow outputs.patchis the only artifact kind produced today, though the artifact model is generic.The reasoning: docs that promise Jira reads generate support tickets we can't close.
context/vendor-datainstead leads with what that surface genuinely does better than anything else in the stack — reachability triage of an existing scanner backlog.Also
Replaces
README.md, which was unmodified Mintlify starter-kit boilerplate pointing at the oldmintlifyCLI andmint.jsoninstead ofmintanddocs.json— following its troubleshooting steps sent you in circles.Verification
Rendered locally with
mint dev:docs.jsonparses; all 24 Console-tab pages return HTTP 200 with correct headingstitle+descriptionfrontmatter/workflows/agents→/workflows/agent-chainredirect resolvesNote for reviewers
install-console.mdxhas unrelated uncommittedlab→stgURL changes in the working tree that predate this work. They are deliberately not included here — they belong in their own commit.🤖 Generated with Claude Code