Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,20 @@
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.

Check failure on line 24 in README.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Vale.Spelling] Did you really mean 'Zensical'? Raw Output: {"message": "[Vale.Spelling] Did you really mean 'Zensical'?", "location": {"path": "README.md", "range": {"start": {"line": 24, "column": 61}}}, "severity": "ERROR"}
250 changes: 0 additions & 250 deletions articles/duration-signals.md

This file was deleted.

Loading
Loading