Add API Designer docs#1912
Conversation
📝 WalkthroughAdd API Designer docsThis PR adds comprehensive documentation for the API Designer VS Code extension. The documentation covers the extension's functionality, getting started guide, design workflow, governance features, and an end-to-end tutorial. ChangesNew documentation pages added:
Content removed:
ImpactThe PR reorganizes and expands API Designer documentation with clear separation of concerns: quick setup (getting-started), core workflow (design-apis), governance (govern-apis), and practical examples (end-to-end-tutorial). This provides users with structured guidance from initial setup through advanced governance features. WalkthroughThis pull request reorganizes and expands the API Designer documentation. It removes a legacy 68-line installation guide from 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/api-designer/end-to-end-tutorial.md`:
- Line 23: Replace the grammatically awkward sentence "Outcome: A working
OpenAPI draft on workspace." with the clearer phrasing "Outcome: A working
OpenAPI draft in your workspace." — locate the exact string in
docs/api-designer/end-to-end-tutorial.md and update it to the suggested text to
improve readability and natural phrasing.
In `@docs/api-designer/getting-started.md`:
- Line 7: Update the product name spelling on the line containing "Design APIs
with **Github Copilot**" to use the correct brand casing "GitHub Copilot" (e.g.,
replace "Github Copilot" with "GitHub Copilot") while leaving the surrounding
text and emphasis ("API Design Skill") unchanged to maintain consistency across
the docs.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 2481c73d-e321-44cd-b6c8-fc473511378b
⛔ Files ignored due to path filters (11)
api-designer/resources/images/option-01.pngis excluded by!**/*.pngapi-designer/resources/images/option-02.pngis excluded by!**/*.pngdocs/api-designer/images/ai-based-editor.pngis excluded by!**/*.pngdocs/api-designer/images/analyze-view.pngis excluded by!**/*.pngdocs/api-designer/images/api-design-skill.pngis excluded by!**/*.pngdocs/api-designer/images/design-view.pngis excluded by!**/*.pngdocs/api-designer/images/form-based-editor.pngis excluded by!**/*.pngdocs/api-designer/images/open-in-api-designer-chat.pngis excluded by!**/*.pngdocs/api-designer/images/options.pngis excluded by!**/*.pngdocs/api-designer/images/validation-issues-bar.pngis excluded by!**/*.pngdocs/api-designer/images/validation-issues.pngis excluded by!**/*.png
📒 Files selected for processing (6)
api-designer/quick-start.mdapi-designer/resources/api-designer-0.1.0.vsixdocs/api-designer/design-apis.mddocs/api-designer/end-to-end-tutorial.mddocs/api-designer/getting-started.mddocs/api-designer/govern-apis.md
💤 Files with no reviewable changes (1)
- api-designer/quick-start.md
|
|
||
| 3. Copilot Chat uses the `api-design` skill, may ask clarifying questions, and iterates until the specification is ready. It then writes and saves the file. | ||
|
|
||
| Outcome: A working OpenAPI draft on workspace. |
There was a problem hiding this comment.
Improve grammar in outcome sentence.
Consider changing this to Outcome: A working OpenAPI draft in your workspace. for clearer, natural phrasing.
As per coding guidelines, "Provide concise, actionable feedback focused on correctness and best practices."
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/api-designer/end-to-end-tutorial.md` at line 23, Replace the
grammatically awkward sentence "Outcome: A working OpenAPI draft on workspace."
with the clearer phrasing "Outcome: A working OpenAPI draft in your workspace."
— locate the exact string in docs/api-designer/end-to-end-tutorial.md and update
it to the suggested text to improve readability and natural phrasing.
|
|
||
| ## What you can do | ||
|
|
||
| - Design APIs with **Github Copilot** using the built-in **API Design Skill**, with guided recommendations and faster fixes. |
There was a problem hiding this comment.
Correct product name spelling to GitHub Copilot.
Line 7 uses Github; please update to GitHub for correct branding and consistency with the rest of the docs.
As per coding guidelines, "Provide concise, actionable feedback focused on correctness and best practices."
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/api-designer/getting-started.md` at line 7, Update the product name
spelling on the line containing "Design APIs with **Github Copilot**" to use the
correct brand casing "GitHub Copilot" (e.g., replace "Github Copilot" with
"GitHub Copilot") while leaving the surrounding text and emphasis ("API Design
Skill") unchanged to maintain consistency across the docs.
1 participant
$subject