docs(readme): tighten mode-comparison table and rework surrounding notes#6
Merged
Merged
Conversation
- Compress table cells to flag-only (single-line rows): drop "flow" suffix in Auth, drop "(JSON)" in Discovery, replace prose Input/Output cells with the actual flags, mark AI agent Auth as "Either" - Replace "Contracts and input" prose section with a [!NOTE] block whose bullets directly mirror the table rows (Versioning, Discovery, Input, Output) - Fold the "Stable JSON output" subsection into the Output bullet - Move the [!WARNING] credential-handling block from mid-usage to the top of the Authentication section where it belongs - Reorder the IAM client section so the redirect-URI [!IMPORTANT] sits next to the numbered steps and the deployment context [!NOTE] follows as supplementary; drop redundant parentheticals and tighten copy
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
1 participant
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
[!NOTE]block whose bullets directly mirror the table rows (Versioning, Discovery, Input, Output) so it's clearer they're explanatory footnotes[!WARNING]from mid-usage to the top of the Authentication section[!IMPORTANT]sits next to the numbered steps and the deployment-context[!NOTE]follows as supplementary; tighten copyTest plan
[!NOTE],[!IMPORTANT], and[!WARNING]callouts render with their styled chrome