Skip to content
telemetry-devPublic

About

docs for telemetry.dev

Resources

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

telemetry.dev docs

This repository is the source of the telemetry.dev documentation. telemetry.dev records traces of AI applications and coding agents, with each model call, tool run, token count, cost, and error in one view.

A trace and its spans in the telemetry.dev dashboard

The SDKs and integrations are open source in the telemetry repository. The ingest service and dashboard are hosted at telemetry.dev and their source is not public. To report a problem with a page, open an issue in this repository.

Run the docs locally

You need Node.js and pnpm.

pnpm install
pnpm dev

pnpm dev prints the local URL. Pages are served under /docs.

Check a change

pnpm test
npx blume validate

pnpm test builds the site and runs the tests in test/. npx blume validate reports broken links.

How the repository is organized

Path Contents
docs/ The pages, as MDX. The path of a file is its URL under /docs; folders in parentheses, such as (coding-agents), group pages without changing their URL.
docs/**/meta.ts The order and titles of the pages in each sidebar section.
components/figures/ Figures drawn in HTML and CSS, so they follow the light and dark themes. model.js holds their data and the Markdown versions used for .md pages and llms-full.txt.
public/ Screenshots and integration marks. ASSET_PROVENANCE.md records where each mark came from.
blume.config.ts, theme.css Site configuration and styles. The site is built with Blume.

Writing guidelines

  • Check each claim against the product and the released SDK versions, not against older pages. Say which SDK version a statement applies to when behavior changed between releases.
  • Document what users can see and rely on: endpoints, limits, status codes, settings, and what data is sent. Leave out how the hosted service is built, such as databases, internal flags, and deployment steps.
  • When a page says what is not captured or not sent, also say what still is.
  • A figure that shows the dashboard has to match it. When the dashboard changes, update the figure too.

Deployment

Changes merged to main deploy to telemetry.dev/docs through Cloudflare Workers Builds. Each pull request gets a preview build.

About

docs for telemetry.dev

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages