Skip to content

Commit c3202ac

Browse files
authored
Merge pull request #9 from apimatic/ai-onboarding-improvements
feat: AI-first onboarding portal and "Why APIMatic" page
2 parents 91281b7 + c921a20 commit c3202ac

4 files changed

Lines changed: 37 additions & 31 deletions

File tree

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
.DS_Store
2-
portal/
2+
portal/
3+
CLAUDE.md

src/APIMATIC-BUILD.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@
1313
"faviconUrl": "static/images/favicon.ico",
1414
"languageConfig": {
1515
"java": {
16-
"packageRepository": "Maven",
17-
"packageSettings": {
18-
"GroupId": "com.apimatic",
19-
"PackageName": "sample-sdk-artifact-id",
20-
"Version": "1.0.0"
21-
}
16+
"packageRepository": "Maven",
17+
"packageSettings": {
18+
"GroupId": "com.apimatic",
19+
"PackageName": "sample-sdk-artifact-id",
20+
"Version": "1.0.0"
21+
}
2222
},
2323
"typescript": {},
2424
"ruby": {},
@@ -32,7 +32,7 @@
3232
"theme": {
3333
"baseTheme": "cosmos",
3434
"colorMode": {
35-
"defaultMode": "system",
35+
"defaultMode": "light",
3636
"disableSwitch": false
3737
},
3838
"colors": {

src/content/toc.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,11 @@
11
toc:
2-
- group: Onboarding Guides
3-
icon: book-open-text
4-
items:
5-
- page: Overview
6-
file: guides/overview.md
72
# The Endpoint and Models sections contain auto-generated content. The 'generate' and 'from' directives instruct APIMatic's Docs generation service
83
# to generate and insert these sections here.
94
- group: Getting Started
105
icon: clock-fading
116
items:
127
# 'generate' specifies that this item will be auto-generated by APIMatic. A file/directory reference is not needed here
13-
- generate: SDK Quickstart
8+
- generate: Quickstart
149
from: getting-started
1510
- generate: API Endpoints
1611
icon: braces
@@ -28,3 +23,8 @@ toc:
2823
- generate: SDK Infrastructure
2924
icon: life-buoy
3025
from: sdk-infra
26+
- group: Why APIMatic
27+
icon: badge-check
28+
items:
29+
- page: What APIMatic Offers
30+
file: why-apimatic/what-apimatic-offers.md
Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,41 @@
1-
## Your API Developer Portal Overview
1+
## What APIMatic Offers
22

3-
### What You Just Created
3+
This developer portal is powered by **APIMatic**. The same platform that generated this experience can turn any OpenAPI specification into a complete developer portal — interactive documentation, auto-generated SDKs in multiple languages, live API testing, and AI-assisted onboarding — in minutes.
44

5-
You've generated a comprehensive API developer portal that transforms your OpenAPI specification into a complete developer experience. This includes interactive documentation, auto-generated SDKs in multiple languages, live API testing capabilities, and AI-accessible documentation.
6-
7-
### Core Capabilities
5+
### What You Get with APIMatic
86

97
<CardGroup cols={2}>
8+
<Card title="AI-Ready API Context" icon="Sparkles">
9+
Context Plugins load your full API context — docs, SDKs, code samples, and setup instructions — into AI coding environments like Claude Code and Cursor, so developers integrate your API through natural language instead of a wall of reference docs. A built-in portal copilot is available too.
10+
</Card>
1011
<Card title="SDK & API Documentation" icon="BookOpenText">
11-
API Reference documentation with language‑specific docs and SDK guides. Developers can explore your API structure before writing any code.
12+
API Reference documentation with language‑specific docs and SDK guides — including idiomatic, ready-to-run code samples complete with imports across all seven SDK languages. Developers can explore your API structure before writing any code.
1213
</Card>
1314
<Card title="Live API Playground" icon="ArrowBigUpDash">
1415
Built-in testing interface supporting all major authentication methods. Developers can make real API calls, see actual responses, and validate their integration approach.
1516
</Card>
1617
<Card title="Multi-Language SDKs" icon="FileBox">
1718
Production-ready client libraries in Java, Python, TypeScript, C#, PHP, Ruby, and Go. Each SDK includes comprehensive documentation, code samples, and follows language-specific best practices.
1819
</Card>
19-
<Card title="API Recipes" icon="Palette">
20+
<Card title="API Recipes" icon="ChefHat">
2021
Step-by-step onboarding flows to help developers implement key API usecases faster.
2122
</Card>
2223
<Card title="Brand Customization" icon="Palette">
2324
Full control over colors, fonts, logos, and layout. Add custom documentation pages, modify navigation, and ensure the portal reflects your brand identity.
2425
</Card>
25-
<Card title="AI Integration Ready" icon="TextSearch">
26-
Automatic generation of llms.txt files makes your API discoverable by AI coding assistants. Built-in API copilot answers developer questions using your documentation.
27-
</Card>
2826
</CardGroup>
2927

3028

31-
### Next Steps
29+
### Ready to Build Your Own?
3230

33-
In the next 15 minutes you can add custom guides, create API recipes, apply your branding, enable AI assistance, and optimize for discoverability.
31+
Bring your API to APIMatic and ship a developer portal like this one in minutes.
3432

3533
<CardGroup cols={2}>
36-
<Card title="Ready to see what's possible?" url="https://docs.apimatic.io/cli-getting-started/advanced-portal-setup/">
37-
Explore the Advanced Features Guide and unlock your portal's full potential.
34+
<Card title="Explore APIMatic" url="https://www.apimatic.io/">
35+
See how APIMatic turns your API specification into a branded, AI-ready developer portal.
36+
</Card>
37+
<Card title="Read the Docs" url="https://docs.apimatic.io/cli-getting-started/advanced-portal-setup/">
38+
Dive into the Advanced Features Guide to set up and customize your own portal.
3839
</Card>
3940
</CardGroup>
4041

@@ -51,15 +52,19 @@ APIMatic automatically updates your portal when your API specification changes.
5152
</Accordion>
5253

5354
<Accordion title="What level of customization and control do we have?">
54-
You can completely customize the look, feel and behavior of your Developer Experience Portal, including primary colors, themes, custom sections, navigation links, and branding. You can also choose to host it on your own custom domain or embed it seamlessly into your existing documentation site using a simple HTML script.
55+
You can completely customize the look, feel and behavior of your Developer Experience Portal, including primary colors, themes, custom sections, navigation links, custom URL slugs, and branding. You can also choose to host it on your own custom domain or embed it seamlessly into your existing documentation site using a simple HTML script.
5556
</Accordion>
5657

5758
<Accordion title="Is there a way we can integrate this with our existing Developer Portal?">
5859
Absolutely. APIMatic provides embeddable portal components that can be seamlessly integrated into your existing documentation sites using a simple HTML script. You can also choose to host the portal separately on your own domain while maintaining your existing portal structure.
5960
</Accordion>
6061

6162
<Accordion title="What AI capabilities does this Developer Portal have?">
62-
APIMatic's Developer Portal includes two key AI features: an API copilot that can answer questions about your API based on information from the API reference documentation and product documentation, and automatic LLMs.txt file generation that makes your documentation AI-accessible to tools like Cursor, GitHub Copilot, ChatGPT, and Claude.
63+
**Context Plugins** let developers connect your API to the AI coding assistant they already use (Cursor, GitHub Copilot, Claude, and more) to search, ask questions, and generate working integration code grounded in your live specification.
64+
65+
The portal also includes a built-in **API Copilot** that answers questions from your API reference and product documentation, and an **AI Assist Menu** that sends any documentation page straight to your preferred AI tool as context with one click.
66+
67+
Automatic **LLMs.txt generation** and per-page Markdown exports make your documentation AI-accessible to tools like Cursor, GitHub Copilot, ChatGPT, and Claude.
6368
</Accordion>
6469

65-
</AccordionGroup>
70+
</AccordionGroup>

0 commit comments

Comments
 (0)