diff --git a/.gitignore b/.gitignore index 4df3b0a..329105e 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ .DS_Store -portal/ \ No newline at end of file +portal/ +CLAUDE.md diff --git a/src/APIMATIC-BUILD.json b/src/APIMATIC-BUILD.json index 5dc7937..5a9eb8b 100644 --- a/src/APIMATIC-BUILD.json +++ b/src/APIMATIC-BUILD.json @@ -13,12 +13,12 @@ "faviconUrl": "static/images/favicon.ico", "languageConfig": { "java": { - "packageRepository": "Maven", - "packageSettings": { - "GroupId": "com.apimatic", - "PackageName": "sample-sdk-artifact-id", - "Version": "1.0.0" - } + "packageRepository": "Maven", + "packageSettings": { + "GroupId": "com.apimatic", + "PackageName": "sample-sdk-artifact-id", + "Version": "1.0.0" + } }, "typescript": {}, "ruby": {}, @@ -32,7 +32,7 @@ "theme": { "baseTheme": "cosmos", "colorMode": { - "defaultMode": "system", + "defaultMode": "light", "disableSwitch": false }, "colors": { diff --git a/src/content/toc.yml b/src/content/toc.yml index 97ad3e6..6d1c57e 100644 --- a/src/content/toc.yml +++ b/src/content/toc.yml @@ -1,16 +1,11 @@ toc: - - group: Onboarding Guides - icon: book-open-text - items: - - page: Overview - file: guides/overview.md # The Endpoint and Models sections contain auto-generated content. The 'generate' and 'from' directives instruct APIMatic's Docs generation service # to generate and insert these sections here. - group: Getting Started icon: clock-fading items: # 'generate' specifies that this item will be auto-generated by APIMatic. A file/directory reference is not needed here - - generate: SDK Quickstart + - generate: Quickstart from: getting-started - generate: API Endpoints icon: braces @@ -28,3 +23,8 @@ toc: - generate: SDK Infrastructure icon: life-buoy from: sdk-infra + - group: Why APIMatic + icon: badge-check + items: + - page: What APIMatic Offers + file: why-apimatic/what-apimatic-offers.md diff --git a/src/content/guides/overview.md b/src/content/why-apimatic/what-apimatic-offers.md similarity index 51% rename from src/content/guides/overview.md rename to src/content/why-apimatic/what-apimatic-offers.md index d10c184..80a3b2a 100644 --- a/src/content/guides/overview.md +++ b/src/content/why-apimatic/what-apimatic-offers.md @@ -1,14 +1,15 @@ -## Your API Developer Portal Overview +## What APIMatic Offers -### What You Just Created +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. -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. - -### Core Capabilities +### What You Get with APIMatic + +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. + -API Reference documentation with language‑specific docs and SDK guides. Developers can explore your API structure before writing any code. +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. Built-in testing interface supporting all major authentication methods. Developers can make real API calls, see actual responses, and validate their integration approach. @@ -16,25 +17,25 @@ Built-in testing interface supporting all major authentication methods. Develope 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. - + Step-by-step onboarding flows to help developers implement key API usecases faster. Full control over colors, fonts, logos, and layout. Add custom documentation pages, modify navigation, and ensure the portal reflects your brand identity. - -Automatic generation of llms.txt files makes your API discoverable by AI coding assistants. Built-in API copilot answers developer questions using your documentation. - -### Next Steps +### Ready to Build Your Own? -In the next 15 minutes you can add custom guides, create API recipes, apply your branding, enable AI assistance, and optimize for discoverability. +Bring your API to APIMatic and ship a developer portal like this one in minutes. - -Explore the Advanced Features Guide and unlock your portal's full potential. + +See how APIMatic turns your API specification into a branded, AI-ready developer portal. + + +Dive into the Advanced Features Guide to set up and customize your own portal. @@ -51,7 +52,7 @@ APIMatic automatically updates your portal when your API specification changes. -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. +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. @@ -59,7 +60,11 @@ Absolutely. APIMatic provides embeddable portal components that can be seamlessl -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. +**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. + +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. + +Automatic **LLMs.txt generation** and per-page Markdown exports make your documentation AI-accessible to tools like Cursor, GitHub Copilot, ChatGPT, and Claude. - \ No newline at end of file +