Skip to content
Merged
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
7 changes: 6 additions & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,12 @@ jobs:
python-version: 3.x
- run: pip install zensical
working-directory: docs
- run: zensical build --clean
- name: Prepare release documentation
run: >-
python docs/scripts/prepare_release.py
--version "$(jq --raw-output .version custom_components/uix/manifest.json)"
--source-revision "${{ github.sha }}"
- run: zensical build --clean --config-file mkdocs.release.yml
working-directory: docs
- uses: actions/upload-pages-artifact@v5
with:
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ __pycache__/
.venv/
docs/site/
docs/.cache/
docs/mkdocs.release.yml
docs/source/uix-docs.json
*.egg-info/

# Test artifacts — actual screenshots are transient; baselines are committed.
Expand Down
20 changes: 20 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,26 @@ tests/

docs/

## External documentation translations

- The English documentation in this repository is canonical. Do not add or
accept translated Markdown copies here.
- Translation curators register independently hosted translations by changing
only `docs/translations.json`. Do not edit generated release files or add a
translation directly to `docs/mkdocs.yml`.
- Each registry entry must use a lowercase ISO 639-1 language code, a native
language name, and public HTTPS site and metadata URLs.
- A translation fork uses `docs/site.json` to set its language, native name,
public site URL, and canonical English URL before running the same docs
release workflow. Preserve this workflow's fork compatibility.
- A translation must publish the `uix-docs.json` metadata contract described in
`docs/source/contributing.md`. The documentation release workflow decides
whether it is current enough to display; unavailable, invalid, or stale
translations must be omitted with a workflow warning rather than blocking
publication.
- Do not change the metadata schema, the one-minor-version eligibility policy,
or the generated footer version without explicit maintainer approval.

If modifying:

- Templates → docs/source/using/templates.md
Expand Down
6 changes: 5 additions & 1 deletion docs/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
site_name: UI eXtension
site_url: https://uix.lf.technology
site_url: https://uix.lf.technology # UIX_RELEASE_SITE_URL
docs_dir: source
theme:
name: material
language: en # UIX_RELEASE_LANGUAGE
variant: classic
features:
- navigation.tabs
Expand Down Expand Up @@ -32,6 +33,9 @@ theme:
custom_dir: overrides
extra:
generator: false
# Replaced in docs/mkdocs.release.yml by docs/scripts/prepare_release.py.
alternate: [] # UIX_RELEASE_ALTERNATES
copyright: "Documentation generated against UIX (local build)" # UIX_RELEASE_COPYRIGHT
plugins:
- search
- git-revision-date-localized:
Expand Down
Loading
Loading