Skip to content

dsinghvi/docs

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 

Repository files navigation

Traceloop Documentation

This repository powers the documentation at https://traceloop.com/docs.

What is in this repository?

This repository contains:

  • Traceloop's Fern API Definition which lives in the definition folder.
  • MDX files which live in the pages folder.

What is in the API Definition?

  • 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.

Definition Validation

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 valid

Debugging

Encountering errors while generating docs? Run the following command to identify where these errors are occurring:

fern generate --docs --log-level debug

Static Assets

Static assets should be stored in your assets subdirectory.

About

Documentation for Traceloop & OpenLLMetry

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • MDX 100.0%