Project Settings

In Theneo, Project Settings is the central hub from which you can customize various aspects of your project, from general settings such as project name and logo to specific features like API Explorer and GPT Search. It enables you to ensure that your project fits your needs, and the needs of your users, in the best possible way.

General Settings

This is the starting point for setting up your project. Here, you can set your Project name and the Project slug, which will be the URL of your project.

You can also upload Light and Dark theme project logos. This ensures your branding remains consistent, irrespective of the theme your users choose.

Features

In the features tab, you can enable or disable various features based on your needs:

• Feedback & Analytics Feature: This allows users to provide feedback on your documentation and provides you with valuable analytics on user interactions.
• API Explorer: It allows users to try out your API endpoints directly from the documentation.
• Automatic Changelog: Theneo simplifies the process of generating changelogs for your projects. The Auto Changelog Doc feature automatically compiles and updates changelogs, saving you time and effort. The software scans your project for changes and automatically generates a comprehensive changelog.
• Default Dark Theme Mode: Enabling this will make Dark Theme the default view mode for your project.
• AI Search: This feature integrates with OpenAI's GPT-4 to provide powerful search functionality. When enabled, it allows users to ask questions in natural language and get answers directly from your documentation. This can greatly enhance the user experience by making it easier for them to find the information they're looking for.
• HTTP Method Display: This feature enhances API documentation by displaying HTTP methods (GET, POST, PUT, DELETE, etc.) in the side menu navigation. It allows users to quickly identify the type of request associated with each API endpoint, improving clarity and usability when browsing the documentation.
• Iframe Generation: Provides the ability to generate iframes for embedding Theneo documentation into other platforms or web pages. This feature enables seamless integration of API documentation within external applications, ensuring accessibility without redirecting users away from their current environment.
• URL Encoding: Ensures that API request URLs are properly encoded to handle special characters, spaces, and unsafe characters correctly. This prevents issues related to incorrect URL formatting and ensures compatibility with web standards for smooth API communication.

Custom Menu

Custom Menu allows users to personalize the default menu structure in Theneo by adding, removing, or modifying menu items. This flexibility ensures that the documentation’s navigation aligns with specific project needs. Users can include additional references, link relevant content, and streamline the navigation process, making it easier for viewers to access important information efficiently.

Custom Menu Main Button Highlighting

To make navigation even more intuitive, the Main Button feature allows users to mark one item (excluding subitems) as the main button in the custom menu. This visually distinct button serves as a primary point of focus in the menu.

Star Icon Functionality:

• A star icon is displayed next to all items in the custom menu (excluding subitems).
• Clicking the star icon marks the item as the Main Button.

Main Button Design in Published View:

• The Main Button will have a distinct design with a highlighted background to make it stand out from other menu items.
• This ensures that users can easily identify the most important or relevant section of the documentation at a glance.