This repository powers the documentation at https://traceloop.com/docs.
This repository contains:
- Traceloop's Fern API Definition which lives in the definition folder.
- MDX files which live in the pages folder.
-
API Documentation: Explore detailed documentation for each of our APIs. Learn about endpoints, request and response formats, authentication methods, and best practices for integration.
-
Getting an API Key: Follow step-by-step instructions on obtaining your API key. Understand the authentication process and ensure a secure and seamless interaction with our services.
To make sure that the definition is valid, you can use the Fern CLI.
npm install -g fern-api # Installs CLI
fern check # Checks if the definition is validEncountering errors while generating docs? Run the following command to identify where these errors are occurring:
fern generate --docs --log-level debugStatic assets should be stored in your assets subdirectory.