docs.telebugs.com

Welcome to the official Telebugs documentation (aka The Telebugs Manual).

Telebugs is a lightweight, self-hosted error tracking tool and Sentry alternative. This site contains the complete user guide, installation instructions, and reference material.

• URL: https://docs.telebugs.com
• Deployment is managed by Skiff.
• HTML and assets are generated by mdBook.

Local development

Prerequisites:

• Rust toolchain (for mdBook): install via rustup.rs

• Install mdBook: cargo install mdbook
• Run locally: mdbook serve --open (opens in your browser with live reload)
• Build static site: mdbook build (outputs to ./public)
• Edit files in src/ and send PRs

Book theme

The open-book layout lives in theme/telebugs.css, with page furniture in theme/index.hbs (based on mdBook 0.5.2) and keyboard/navigation enhancements in theme/telebugs.js. It uses local system fonts. The appearance menu offers System, Light, and Dark; explicit choices persist between pages, while System follows the device's appearance. The contents leaf becomes a drawer below 1080px.

The logos in src/assets/images/ and favicons in theme/ match the assets in the Telebugs marketing website. The fingerprinted favicon, search index, and contents files at the root of src/ preserve previously published asset URLs; mdBook copies them through on each build. Current pages use newly generated assets. Keep these compatibility files while they remain in the URL baseline.

URL stability

The public URL contract is recorded in url-stability-baseline.json. After building the site, verify that all existing pages, assets, redirects, internal links, heading fragments, REST API problem-type URLs, and crawl directives remain valid:

mdbook build
python3 scripts/url_stability.py check

The check fails when an existing HTML path or public asset disappears, an nginx redirect changes, a link or fragment breaks, a problem-type URL changes, a canonical points outside docs.telebugs.com, or a new noindex directive appears.

Only recapture the baseline when an intentional change to the public URL contract has been explicitly approved:

python3 scripts/url_stability.py capture

Contributing

• Follow the existing structure in src/.
• Use clear, concise Markdown.
• Preview changes locally with mdbook serve.
• All contributions are welcome (typos, clarifications, new sections)!

License

This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

See the LICENSE file for details, or visit: https://creativecommons.org/licenses/by-nc-sa/4.0/