Theneo Theme - Solid

## Sections
• [Introduction](https://app.theneo.io/solid/sample-documentation/getting-started/introduction.md): Theneo is the quickest, simplest way to generate high-quality, interactive API docs. Unlock the full potential of AI-powered API documentation: Create stunning, low-maintenance, and engaging docs with a single upload. Theneo streamlines every step of the process, ensuring that your documentation is not only comprehensive but also interactive and user-friendly. All about this template Single Page Template You can now choose between two powerful documentation layouts: Continuous Scrolling and Single Page . The new Single Page template is perfect for tutorials and guides — offering a focused, step-by-step reading experience, faster per-page loading, and clean section-based navigation. Activating the Single Page layout is simple — just head to your project's settings on the dashboard, open the Features tab, and toggle on the Single Page Template option. For more detailed steps, visit our guide here. Getting Started To create and publish documentation in Theneo, you first need to create a Theneo account. If you don’t have an account yet, you can sign up for free here . Create Your First Doc When you log into Theneo, start by adding a new project from the homepage. Your project could be an API reference, a developer guide, or any type of documentation you need. Give your project a title, select the appropriate workspace, and you're on your way. 1 Uploading Your API Specification Theneo accommodates a wide array of API specifications, making it easy to get started regardless of whether you have an existing spec or not. If you're equipped with Swagger, OpenAPI, GraphQL, or another format, the upload process is designed to be straightforward and efficient. In case you don't have a spec ready, Theneo offers tools to help you create one from scratch. Use our intuitive interface to define your API endpoints directly within the platform. For additional guidance on creating or importing your spec and ensuring format compatibility, check out our guide. If you do not have a spec, do not worry you can define that in Theneo as well, for more info click here . 2 Selecting Your AI Co-Pilot Once your API specification is uploaded, you can harness the power of Theneo's AI Co-pilot to enrich your content. Decide whether you want the AI to fully generate the content, enhance what you've already created, or if you prefer to proceed without AI assistance. If you're looking to streamline the setup, simply click on "Quick Start" to bypass the customization and move directly to publishing. 3 Publish Utilize Theneo's editing suite for final adjustments before publishing. Preview to ensure everything is perfect and publish to make your documentation available to users. It’s documentation made simple, yet powerful and comprehensive Just Getting Started? Check out our Quickstart Guide. Need any assistance? Book a meeting
• [Single Page Template](https://app.theneo.io/solid/sample-documentation/getting-started/single-page-template.md): We’re thrilled to introduce the Single Page Template — a flexible and focused layout option for your documentation. You now have the ability to choose between two layout styles: Continuous Scrolling (best for API references) Single Page (best for guides, tutorials, and onboarding flows) With this new feature, you can tailor your documentation experience to best suit your content and your readers. Benefits of the Single Page Template Modular Layout Each section appears on its own dedicated page, making navigation cleaner and more intuitive. Improved Performance Only the requested page loads, resulting in faster load times and better performance — especially for large docs. Clear Navigation & URLs Each section has a unique URL, making deep linking and sharing easier. Optimized for Guides Perfect for linear, step-by-step content like tutorials, onboarding instructions, or user walkthroughs. Better Readability Reduces scrolling fatigue and gives readers a more focused reading experience. How to Activate the Single Page Template Activating the Single Page Template is quick and easy. Just follow these steps: 1 Go to Your Dashboard Log in to your Theneo dashboard and navigate to the project you want to update. 2 Open Project Settings Click on the Settings tab of your selected project. 3 Go to the Features Tab Inside Project Settings, navigate to the Features tab 4 Enable the Single Page Template Find the toggle labeled Single Page Template and turn it on. For configuraing the social media links please go to your banding configuration https://app.theneo.io/branding Switching Back If you ever want to switch back to the Continuous Scrolling layout, simply return to the Features tab and toggle off the Single Page Template. Your content will automatically return to the scrolling layout without data loss.
• [Customizing](https://app.theneo.io/solid/sample-documentation/getting-started/customizing.md): In Theneo, you have complete control over the look and feel of your documentation. This is achieved through an extensive set of color customization options that cater to every aspect of your project's interface. Here's a detailed overview of what you can configure: General Settings: Logos : Upload separate logos for light and dark modes, ensuring clear visibility regardless of theme. Ideal dimensions are provided for optimal display. Favicon : Customize the small icon that appears in browser tabs and bookmarks to make your site easily identifiable. Logo Hyperlink : Direct users to your desired URL through the logo in your documentation. Attribution : Toggle the "Powered by Theneo" attribution on or off to match your branding preferences. Document Font : Select from a variety of fonts to maintain consistency across your documentation. Color Customization of the published view projects: Global Settings: Body Text : Set the text color for readability. Section Headings: Highlight section titles. Background: Choose a primary background color. Accents: Customize borders and outlines. Buttons: Define button colors. Links: Customize hyperlink colors. Left Sidebar Menu: Item Colors: Set colors for menu items and active selection. Background: Choose a sidebar background color. Widget Cards: Code Snippet Card: Customize the header and body colors for request, response, and object example cards. Base URL Card: Set header and body background colors. Custom CSS and JavaScript Custom CSS and JavaScript offer powerful tools to personalize and enhance your Theneo documentation, giving you full control over its appearance and functionality. This feature allows you to create a highly branded, interactive, and tailored user experience. Benefits: Enhanced Personalization : Customize the visual style to perfectly align with your brand. Extended Functionality : Implement advanced features or third-party integrations using JavaScript. Improved User Experience : Optimize layout, navigation, and interactions for a more user-friendly and branded interface.
• [Theneo Web Editor](https://app.theneo.io/solid/sample-documentation/getting-started/theneo-web-editor.md): Theneo's web editor is a rich and intuitive platform, equipped with a variety of widgets that enrich the documentation experience. These widgets add depth and clarity to your API documentation, making it more engaging and informative. You can easily access these widgets by simply going to a new line in the editor and typing /, which brings up the widget options. Additionally, Theneo's live collaboration feature enables real-time teamwork, allowing multiple users to simultaneously edit, comment, and review documentation. This streamlines the editing process, reduces bottlenecks, and fosters seamless collaboration across teams. Whether you're working in the same room or across different time zones, live collaboration ensures that everyone stays aligned and up to date on changes. Let's take a look at the widgets available: Code Block Perfect for displaying code snippets, helping users und/erstand implementation details in different programming languages. Here's an example of a formatted code snippet in JavaScript: JavaScript const city = "London"; const apiKey = "your_api_key_here"; fetch(https://api.openweathermap.org/data/2.5/weather?q=${city}&appid=${apiKey}&units=metric) .then(res => res.json()) .then(data => { console.log(data.main.temp + "°C"); }); Callout Draws focus to important information, tips, or warnings, ensuring key messages are not missed. Single Card Card Title This is how the card widget appears, with an icon, title and link. Clicking on this card will take you to the Basics of APIs section. Double Card Card Title Add description here Card Title Add description here Triple Card Card Title Add description here Card Title Add description here Card Title Add description here Card Grid Card Title Add description here Card Title Add description here Card Title Add description here Card Title Add description here Accordion 🚀 Getting Started with the Accordion Widget Welcome to the Accordion Widget! This feature helps keep your content organized and user-friendly. Below are some key details you can include inside an accordion: 📌 Key Features: Expandable and collapsible sections Supports text, images, callouts, and code blocks Ideal for FAQs, step-by-step guides, and technical documentation Accordion Group 📌 What is API Documentation? API documentation provides a detailed guide on how to interact with an API, including endpoint details, request/response formats, authentication methods, and usage examples. 💡 Why is it Important? Helps developers understand API functionality Improves integration efficiency Ensures consistency in API usage 🔑 How to Authenticate API Requests API Authentication Methods: API Key: Include an API key in the request headers. OAuth 2.0: Authenticate via access tokens. JWT Tokens: Secure authentication with signed tokens. 💡 Example API Key Authentication: CURL curl -H "Authorization: Bearer YOUR_API_KEY" https://api.example.com/data ⚠️ Common API Errors 400 Bad Request: Invalid request syntax. 401 Unauthorized: Missing or invalid authentication. 404 Not Found: Requested resource doesn’t exist. 500 Internal Server Error: Unexpected issue on the server. 💡 How to Fix Errors? Double-check request parameters and headers. Ensure authentication credentials are correct. Review API documentation for required inputs Steps How to Add a Steps Widget 1 First Step Navigate to the point in your text where you want to insert the Steps widget. 2 Second Step Type /Steps on a new line. 3 Third Step Select the Steps option that appears. Table Feature Description Available Authentication Secure user login with OAuth2.0 Yes Rate Limiting Limits the number of requests per hour Yes Data Export Ability to export data in various formats No Real-time Updates Provides live updates without refreshing Yes Multi-Language Support Documentation available in multiple languages Coming Soon
• [Basics of APIs](https://app.theneo.io/solid/sample-documentation/api-reference/basics-of-apis.md): Theneo offers a comprehensive and flexible selection of API formats and collection types to meet diverse integration and development needs. Our platform supports various API formats, such as REST, SOAP, GraphQL, and Async APIs, each designed for specific use cases and requirements. We also provide compatibility with multiple API specification collections, ensuring smooth integration and an efficient development process. HTTP Methods HTTP methods, or verbs, denote actions performed on resources. Theneo APIs support various HTTP methods: GET: Retrieve a representation of a specific resource. Example: Retrieving transaction details. POST: Submit data to create a new resource or trigger a state change. Example: Creating a new customer profile. PUT: Replace all representations of a target resource with the provided payload. Example: Updating a subscription plan. DELETE: Remove a specified resource. Example: Deleting a stored card. PATCH: Apply partial modifications to a resource. Example: Changing the status of an existing order. Parameters Parameters allow customization of API requests and responses. Theneo APIs support four types of parameters: Path Parameters: Integral parts of the endpoint URL, identifying specific resources. Query Parameters: Appended to the endpoint URL to filter or paginate results. Request Body Parameters: Included in the request body, transmitting data to the API server. Response Body Parameters: Represent data returned by the server in response to a request. HTTP Status Codes HTTP status codes communicate the outcome of client requests. Theneo employs HTTP status codes categorized into the following classes: Success (200): The request was successfully processed. Example: Successfully retrieved a resource or completed an action. 400 (Bad Request): The server could not understand the request due to invalid syntax. Example: Missing required parameters in the request. 401 (Unauthorized): Authentication is required and has failed or has not yet been provided. Example: Invalid or missing API key. 402 (Request Failed): The parameters were valid but the request failed. Example: Insufficient funds or expired credit card. 403 (Forbidden): The client does not have access rights to the content. Example: Attempting to access a resource without the necessary permissions. 404 (Not Found): The server can not find the requested resource. Example: Trying to access an endpoint that does not exist.
• [Authentication](https://app.theneo.io/solid/sample-documentation/api-reference/authentication.md): When it comes to interacting with APIs, authentication is a critical step to ensure secure communication between your application and the API service. API authentication is performed via HTTP Basic Auth, which involves including your API key in the HTTP request headers. This method verifies your identity and grants you access to the API's resources, ensuring that only authorized users can make requests. Theneo Sample API uses API keys to authenticate requests. Add headers to an HTTP request When issuing an HTTP request to Theneo, each request must contain an Api-Key header that specifies a valid API key and must be encoded as JSON with the Content-Type: application/json header. CURL curl -s -X POST "https://app.theneo.io" \ -H "Content-Type: application/json" \ -H "Api-Key: YOUR_API_KEY" \ -d '{ "given_name": "Theneo", "last_name": "APIDoc", "mail": "hello@theneo.io", "phone_number": "" } Your API keys grant significant access, so it’s crucial to keep them safe! Avoid sharing your secret API keys in public places like GitHub, client-side code, and similar locations. API requests without authentication will fail. To retrieve your API key from app.theneo.io, follow these steps: 1 Sign in Navigate to app.theneo.io and sign in with your credentials. 2 User Settings Once logged in, locate the user settings. 3 Tools & Integrations Tab Within the user settings, find the "Tools & Integrations" tab. Click on it to access settings related to integrations and tools. 4 Locate API Key In the Tools & Integrations tab, you should find your API key listed.
• [Create customer](https://app.theneo.io/solid/sample-documentation/rest-api-reference/create-customer.md): Create customer allows users to add a new customer to the system, providing essential details such as name, email, address, and phone number. By utilizing this functionality, users can easily store and manage customer information for seamless transactions and interactions within the application.
• [Update customer](https://app.theneo.io/solid/sample-documentation/rest-api-reference/update-customer.md): Update customer allows users to modify and update customer information within the system. Users can easily adjust customer details such as name, email, phone number, and more. This section provides a seamless way to keep customer data accurate and up-to-date.
• [Retrieve customer](https://app.theneo.io/solid/sample-documentation/rest-api-reference/retrieve-customer.md): This section allows users to retrieve detailed information about a specific customer within the system. Users can access essential details such as the customer's name, email address, phone number, address, and creation source. By utilizing this functionality, users can efficiently manage customer data and preferences.
• [List all customers](https://app.theneo.io/solid/sample-documentation/rest-api-reference/list-all-customers.md): This section allows users to retrieve a list of all customers associated with the project. By accessing this data, users can gain insights into their customer base, track customer interactions, and manage customer information effectively within the project.
• [Delete customer](https://app.theneo.io/solid/sample-documentation/rest-api-reference/delete-customer.md): Deletes a customer from the system permanently, and this action cannot be reversed. Additionally, it promptly cancels any active subscriptions associated with the customer.