diff --git a/src/content/docs/features/api-catalog.mdx b/src/content/docs/features/api-catalog.mdx index 95caa8e..04534d8 100644 --- a/src/content/docs/features/api-catalog.mdx +++ b/src/content/docs/features/api-catalog.mdx @@ -2,21 +2,21 @@ title: "API Catalog in Treblle" --- -The API Catalog in Treblle 3.0 is a centralized repository where you can publish and manage your API documentation. It allows teams to collaborate effectively by sharing API details without granting full access to the API itself. +The API Catalog is a centralized repository where you can publish and manage your API documentation. It allows teams to collaborate effectively by sharing API details without granting full access to the API itself. This is particularly useful if you want someone in your team to interact only with the API documentation rather than the API endpoints directly. --- -#### Key Permissions - -It's important to note that **only the owner of an API** has the authority to publish it to the API Catalog. This ensures that API visibility and sharing are carefully controlled, providing a secure and managed environment for catalog updates. +:::note +Only the API's owner has the authority to publish it to the API Catalog has the authority to publish it to the API Catalog. This ensures that API visibility and sharing are carefully controlled, providing a secure and managed environment for catalog updates. +::: ## Steps to add an API to the Catalog -##### 1. Navigate to API Settings +##### 1. Go to API Settings -- Go to your dashboard and select the API you want to add to the catalog. +- Select the API to add to the catalog. - On the left-hand menu, click **API Settings**. + -Example: -The Payment API supports multiple payment methods, including credit cards, PayPal, and digital wallets. + Example: + The Payment API supports multiple payment methods, including credit cards, PayPal, and digital wallets. - + -- Click **Publish** to make the API live in the catalog. + Click **Publish** to make the API live in the catalog. ## Steps to view the API Catalog ##### 1. Access the API Catalog -- From the dashboard, click **API Catalog** in the left-hand menu. + Click **API Catalog** from the dashboard in the left-hand menu. - + ##### 2. Explore Published APIs +View the list of published APIs. + -- View the list of published APIs. -- Use sorting options like: +Use sorting options like: - Popular - Grade @@ -95,7 +96,7 @@ The Payment API supports multiple payment methods, including credit cards, PayPa style={{ borderRadius: "8px" }} /> -- Filter APIs by SDK or environment for easier navigation. +Filter APIs by SDK or environment for easier navigation. ## Steps to interact with an API @@ -103,7 +104,7 @@ The Payment API supports multiple payment methods, including credit cards, PayPa Click on a published API to view detailed information: -- **API Score**: Quality assessment based on design, performance, and security. +- **API Score**: A quality assessment based on design, performance, and security. - **Followers**: Number of users following the API. - **Tags and Category**: Metadata for discovery. - **Description**: Overview of the API's purpose and functionality. @@ -114,9 +115,13 @@ Click on a published API to view detailed information: style={{ borderRadius: "8px" }} /> -**Tip:** You can interact with your API documentation more effectively using Alfred, the AI assistant. +:::tip +You can interact with your API documentation more effectively using Alfred, the AI assistant. +::: + +Alfred helps you navigate and understand your API docs, making it particularly useful for new team members. -Alfred helps you navigate and understand your API docs, making it particularly useful for new team members. Learn more about what's new in API catalog in Treblle 3.0. +Learn more about what's new in API catalog in Treblle 3.0 Blog. ##### 2. Additional Information diff --git a/src/content/docs/features/api-compliance.mdx b/src/content/docs/features/api-compliance.mdx index ef7dff2..ed98dd0 100644 --- a/src/content/docs/features/api-compliance.mdx +++ b/src/content/docs/features/api-compliance.mdx @@ -2,7 +2,7 @@ title: "API Compliance in Treblle" --- -The API Compliance feature in Treblle 3.0 helps you ensure your API adheres to regulatory requirements such as GDPR, CCPA, and PCI DSS by identifying sensitive data within API requests and responses. +The API Compliance feature helps you ensure your API adheres to regulatory requirements such as GDPR, CCPA, and PCI DSS by identifying sensitive data within API requests and responses. ## Steps to Use API Compliance @@ -48,7 +48,7 @@ The API Compliance feature in Treblle 3.0 helps you ensure your API adheres to r ##### 4. Use the Graph View -- In the **Graph View**, monitor your API’s compliance trend to spot patterns or improvements. +- Monitor your API’s compliance trend in the Graph View to spot patterns or improvements. Treblle Sign-In page. - - Click **Sign in with SSO**, enter your organization's identifier, and log in. + - Sign in with SSO, enter your organization’s identifier, and log in. MFA adds an additional layer of security by requiring two or more verification steps during login. Typically, it combines something you know (like a password) and something you have (like a mobile app code). +- The MFA adds a layer of security of security by requiring two or more verification steps during login. Typically, it combines something you know (like a password) and something you have (like a mobile app code). ### Enabling MFA @@ -124,14 +124,10 @@ For teams or contractors, Social Sign-On offers a fast and convenient way to acc ## Social Sign-On - The Social Sign-On lets users log in with existing accounts such as Google or GitHub. -- This feature is particularly useful for teams that prefer using familiar credentials instead of creating new ones. +- This feature is handy for teams that prefer using familiar credentials instead of creating new ones. - -## Summary - -Treblle's authentication features are designed to balance security and usability, providing multiple options to secure your workspace while maintaining a smooth user experience. diff --git a/src/content/docs/features/custom-alert.mdx b/src/content/docs/features/custom-alert.mdx index 8dcf198..741854c 100644 --- a/src/content/docs/features/custom-alert.mdx +++ b/src/content/docs/features/custom-alert.mdx @@ -2,16 +2,7 @@ title: Custom Alerts in Treblle --- -Custom Alerts in Treblle 3.0 allow you to stay informed about critical API events without sifting through endless logs. This feature lets you configure specific triggers, ensuring timely notifications for error spikes, performance issues, or unusual activities. - -In this docs, we’ll cover: - -- Setting up Custom Alerts. -- Configuring saved searches. -- Choosing notification channels. -- Examples of Custom Alerts. - ---- +Custom Alerts allow you to stay informed about critical API events without sifting through logs. This feature lets you configure specific triggers, ensuring timely notifications for error spikes, performance issues, or unusual activities. ## Prerequisites @@ -21,11 +12,9 @@ Before you begin, ensure you have: - Access to your project in the Treblle dashboard. - Permissions to create and manage alerts. ---- - ## Setting Up Custom Alerts -### Steps to create a Saved Search +### Steps to Create a Saved Search Saved searches allow you to define filters for specific API events. @@ -132,7 +121,7 @@ For example, filter all `POST` requests to `/auth/register`. ##### 4. **Assign recipients:** -- You have the option to add up to five team members who should receive the alerts. +- You can add up to five team members who should receive the alerts. 1. **Create a Treblle Account** - First, [sign up for a free Treblle account](https://identity.treblle.com/register). This gives you access to the Treblle dashboard where you'll be able to observe your APIs. + First, [sign up for a free Treblle account](https://identity.treblle.com/register). This will give you access to the Treblle dashboard, where you can observe your APIs. 2. **Create Your First Project** diff --git a/src/content/docs/index.mdx b/src/content/docs/index.mdx index 27c66dd..ade9496 100644 --- a/src/content/docs/index.mdx +++ b/src/content/docs/index.mdx @@ -1,10 +1,10 @@ --- title: Treblle -description: Treblle helps engineering and product teams build, ship and understand their REST APIs in one single place. +description: Treblle helps engineering and product teams build, ship and understand their REST APIs in one place. template: splash image: /homepage.png hero: - tagline: API Intelligence Platform, helping engineering and product teams build, ship, and understand their REST APIs in one single place. + tagline: API Intelligence Platform, helping engineering and product teams build, ship, and understand their REST APIs in one place. image: file: ../../assets/alfred.gif actions: @@ -46,7 +46,7 @@ import { Steps } from '@astrojs/starlight/components'; ## How to use Treblle? -Treblle comes as an easy-to-use SDK that helps your Engineering and Product teams create and manage REST APIs quickly, and more effectively. We support over 15 different languages and frameworks, and add more all the time. If you don't see your language supported: get in touch with us! +Treblle is an easy-to-use SDK that helps your Engineering and Product teams create and manage REST APIs quickly and effectively. We support over 15 different languages and frameworks and always add more. If you don’t see your language supported,[contact us](https://discord.gg/NJWYYmMvuE)!