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
57 changes: 57 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: Docs

on:
push:
branches: [main]
paths:
- ".github/workflows/docs.yml"
- "docs/**"
- "mkdocs.yml"
pull_request:
paths:
- ".github/workflows/docs.yml"
- "docs/**"
- "mkdocs.yml"
workflow_dispatch:

permissions:
contents: read

concurrency:
group: pages
cancel-in-progress: false

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
with:
persist-credentials: false
- uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: "3.13"
cache: pip
cache-dependency-path: docs/requirements.txt
- name: Install documentation dependencies
run: python -m pip install --requirement docs/requirements.txt
- name: Build documentation
run: mkdocs build --strict
- uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
with:
path: site

deploy:
if: github.event_name != 'pull_request'
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
/target
.qual-cache/
.claude/
/site/
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Added

- A searchable Material for MkDocs site that brings installation, configuration,
adoption, cost/coverage, all 92 rule pages, CLI reference, JSON contracts,
RFCs, architecture, and research evidence into one GitHub Pages deployment.

### Changed

- README, CLI, GitHub, crates.io, and PyPI-facing copy now lead with Qual as
the Manim-aware linter: render-time errors, visual bugs, and per-frame
performance traps before rendering. The README is a concise product entry
point, while detailed operation and integration material lives in the docs.

## [0.3.0] - 2026-07-30

### Added
Expand Down
6 changes: 3 additions & 3 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ name = "qual"
version = "0.3.0"
edition = "2024"
rust-version = "1.85"
description = "Static lifecycle and performance analysis for Manim scenes"
description = "A Manim-aware linter for render-time errors, visual bugs, and per-frame performance traps"
license = "MIT"
publish = ["crates-io"]
repository = "https://github.com/Poietra/qual"
homepage = "https://github.com/Poietra/qual"
documentation = "https://github.com/Poietra/qual#readme"
homepage = "https://poietra.github.io/qual/"
documentation = "https://poietra.github.io/qual/"
readme = "README.md"
keywords = ["manim", "linter", "static-analysis", "animation", "python"]
categories = ["development-tools", "command-line-utilities"]
Expand Down
550 changes: 110 additions & 440 deletions README.ja.md

Large diffs are not rendered by default.

Loading
Loading