Quickstart
Get started with Theneo and publish your first API docs in minutes.
Creating intuitive, detailed, and easy-to-navigate API documentation has never been easier. Theneo streamlines every step of the process, ensuring that your documentation is not only comprehensive but also interactive and user-friendly. Here's how you can quickly set up your project in Theneo.
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.
Uploading Your API Specification
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.
Selecting Your AI Co-Pilot
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.
Setting Permissions and Fine-Tuning Your Project
Setting Permissions and Fine-Tuning Your Project
Set your project’s visibility and invite collaborators according to your workflow needs. With Theneo, you can start with a private project and go public when you're ready, seamlessly inviting others to contribute. Manage these settings at any time to fit your project’s development lifecycle.
You can change project level permission and even set up advanced access management later in the project settings.
Publish
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
Optional steps
What made this section unhelpful for you?
On this page
- Quickstart