Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
c6bab4b
Update directory structure for Zensible
winsmith May 4, 2026
4067607
Add rudimentary zensible configuration file
winsmith May 4, 2026
2d5a284
ci: add Azure Static Web Apps workflow file
winsmith May 4, 2026
f063923
Update CI for SWA
winsmith May 4, 2026
1f6d3a6
Move content from index.njk to index.md
winsmith May 4, 2026
f897f27
Update Repo URL
winsmith May 4, 2026
eb2ae3a
Rudimentary Color scheme
winsmith May 4, 2026
b9decec
Add TelemetryDeck App Analytics
winsmith May 4, 2026
82c9e07
Convert warnings with regex
winsmith May 4, 2026
99f7b35
Convert infos with regex
winsmith May 4, 2026
44173b8
Update logo and favicon
winsmith May 4, 2026
0743d65
docs: update README with local dev instructions
May 10, 2026
53eac2d
feat: fix image references
May 10, 2026
4af87ee
feat: try grouping sections
May 10, 2026
5e8671b
feat: try serving markdown
May 10, 2026
b6611d6
Add deprecatd status to pages
winsmith May 4, 2026
0b990e4
Remove a warning
winsmith May 13, 2026
f8c5caa
feat: document v3 sdk
kkostov May 25, 2026
325e701
wip: sdk setup is now an overview page with an icon
kkostov Jun 3, 2026
2b8af6e
Merge branch 'feature/zensible' of github.com:TelemetryDeck/docs into…
winsmith Jun 22, 2026
2a1f01c
Updated Query API to V4
winsmith Jun 22, 2026
e807667
Update structure to include navigation tabs
voidedmain Aug 5, 2026
702e3b2
Adjust structure and visual style of index.md, seperate zensical docs…
voidedmain Aug 30, 2026
fa7df01
Rename Making an Account to Create an Account, add grid cards to SDK …
voidedmain Sep 16, 2026
8ee5fac
Add icons to navigation, rename login options to authentication
voidedmain Sep 18, 2026
a992ed2
Clean up SDK pages, add icons to SDK pages, remove duplicates for Rea…
voidedmain Sep 18, 2026
81efe5a
Replace wrong link
voidedmain Sep 18, 2026
3836a4e
Clean up AARRR pages, merge and clean up information on How to write …
voidedmain Sep 18, 2026
7039b7b
Move SDK related pages to the new folder that matches new navigation …
voidedmain Sep 18, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions .github/workflows/azure-static-web-apps-purple-bush-012fe8010.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: Azure Static Web Apps CI/CD

on:
push:
branches:
- feature/zensible
pull_request:
types: [opened, synchronize, reopened, closed]
branches:
- feature/zensible

jobs:
build_and_deploy_job:
if: github.event_name == 'push' || (github.event_name == 'pull_request' && github.event.action != 'closed')
runs-on: ubuntu-latest
name: Build and Deploy Job
steps:
- uses: actions/checkout@v3
with:
submodules: true
lfs: false
- name: Replace TelemetryDeck App ID
env:
TELEMETRYDECK_APP_ID: ${{ secrets.TELEMETRYDECK_APP_ID }}
run: |
sed -i "s|#TELEMETRYDECK_APP_ID#|${TELEMETRYDECK_APP_ID}|g" overrides/partials/integrations/analytics/telemetrydeck.html
- uses: actions/setup-python@v6
with:
python-version: 3.x
- run: pip install zensical
- run: zensical build --clean
- name: Generate llms.txt and ship raw markdown
run: python3 scripts/build_llms.py
- name: Build And Deploy
id: builddeploy
uses: Azure/static-web-apps-deploy@v1
with:
azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_API_TOKEN_PURPLE_BUSH_012FE8010 }}
repo_token: ${{ secrets.GITHUB_TOKEN }} # Used for Github integrations (i.e. PR comments)
action: "upload"
###### Repository/Build Configurations - These values can be configured to match your app requirements. ######
# For more information regarding Static Web App workflow configurations, please visit: https://aka.ms/swaworkflowconfig
app_location: "site"
api_location: ""
skip_app_build: true
skip_api_build: true
output_location: ""
###### End of Repository/Build Configurations ######

close_pull_request_job:
if: github.event_name == 'pull_request' && github.event.action == 'closed'
runs-on: ubuntu-latest
name: Close Pull Request Job
steps:
- name: Close Pull Request
id: closepullrequest
uses: Azure/static-web-apps-deploy@v1
with:
azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_API_TOKEN_PURPLE_BUSH_012FE8010 }}
action: "close"
31 changes: 31 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Documentation
on:
push:
branches:
- master
- main
permissions:
contents: read
pages: write
id-token: write
jobs:
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- uses: actions/configure-pages@v6
- uses: actions/checkout@v6
- uses: actions/setup-python@v6
with:
python-version: 3.x
- run: pip install zensical
- run: zensical build --clean
- name: Generate llms.txt and ship raw markdown
run: python3 scripts/build_llms.py
- uses: actions/upload-pages-artifact@v5
with:
path: site
- uses: actions/deploy-pages@v5
id: deployment
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -139,3 +139,4 @@ site/
Context.md
Context/
CLAUDE.md
docs/.vscode/settings.json
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,20 @@ Welcome to the public documentation for TelemetryDeck. The output of these pages
We're incredibly grateful for pull requests or issues that improve things or let us know about errata and missing or unclear bits of information! <3

Check out `articles/documentation.md` for an overview of how documentation pages are formatted.


## Local Development

We use Python `pip`. You can follow the setups at https://zensical.org/docs/get-started/#installation for the initial setup.

Note: Make sure the Python version is recent e.g. 3.14 or later (`python3 --version`).

## LLM and agent friendly output

Every page is also published as raw Markdown alongside the rendered HTML. After `zensical build`, run `python3 scripts/build_llms.py` to:

- copy each source `.md` from `docs/` into the corresponding location in `site/` (so `https://docs.telemetrydeck.com/articles/insights.md` returns the source for `/articles/insights/`),
- write `site/llms.txt` following the [llms.txt](https://llmstxt.org) convention,
- write `site/llms-full.txt` containing every page concatenated for one-shot ingestion.

Both deploy workflows run this step automatically after the Zensical build.
Loading
Loading