Warning
This is a test for a new documentation system. Trust nothing and no one. The original TelemetryDeck documentation still lives at https://telemetrydeck.com/docs/ for now.
Welcome to TelemetryDeck¶
TelemetryDeck helps you understand how users interact with your application through privacy-focused analytics. With just an SDK integration, you'll get valuable insights automatically – no complex configuration required.
Getting Started in 2 simple steps¶
- Choose and install the SDK for your platform from the guides below
- Deploy your app to start collecting data
Once your updated app is in users' hands, TelemetryDeck will begin collecting data. It may take some time before you see meaningful insights, depending on your app's usage.
What's next after setup?¶
After setting up the SDK and deploying your app, your most important next step is to learn how to use the dashboard to analyze your data:
- Analytics Walkthrough - Learn how to navigate TelemetryDeck, interpret insights, and use analytics to make data-driven decisions that improve your app and grow your user base.
Documentation Feedback¶
If you find an error or feel like the documentation could be improved somewhat, we'd love to hear from you! Either directly submit a change request with the buttons on each page, or open an issue in our Docs GitHub Repository.
The documentation guide explains all markdown and additional features you can use while writing documentation for TelemetryDeck.
Get started¶
For full documentation visit zensical.org.
Commands¶
zensical new- Create a new projectzensical serve- Start local web serverzensical build- Build your site
Examples¶
Admonitions¶
Go to documentation
Note
This is a note admonition. Use it to provide helpful information.
Warning
This is a warning admonition. Be careful!
Details¶
Go to documentation
Click to expand for more info
This content is hidden until you click to expand it. Great for FAQs or long explanations.
Code Blocks¶
Go to documentation
-
Go to documentation
Code annotations allow to attach notes to lines of code.
Code can also be highlighted inline: print("Hello, Python!").
Content tabs¶
Go to documentation
Diagrams¶
Go to documentation
graph LR
A[Start] --> B{Error?};
B -->|Yes| C[Hmm...];
C --> D[Debug];
D --> B;
B ---->|No| E[Yay!];
Footnotes¶
Go to documentation
Here's a sentence with a footnote.1
Hover it, to see a tooltip.
Formatting¶
Go to documentation
- This was marked (highlight)
- This was inserted (underline)
This was deleted (strikethrough)- H2O
- ATA
- Ctrl+Alt+Del
Icons, Emojis¶
Go to documentation
:sparkles::rocket::tada::memo::eyes:
Maths¶
Go to documentation
Needs configuration
Note that MathJax is included via a script tag on this page and is not
configured in the generated default configuration to avoid including it
in a pages that do not need it. See the documentation for details on how
to configure it on all your pages if they are more Maths-heavy than these
simple starter pages.
Task Lists¶
Go to documentation
- Install Zensical
- Configure
zensical.toml - Write amazing documentation
- Deploy anywhere
Tooltips¶
Go to documentation
-
This is the footnote. ↩