Skip to content

telebugs/docs.telebugs.com

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

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 ./book)
  • Edit files in src/ and send PRs

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/