# Summary

- [Introduction](introduction.md)
- [Nomenclature](nomenclature.md)
- [Installation](installation.md)
- [Getting Started](getting-started.md)
- [Binary Releases](binary-releases.md)
- [Commands](commands.md)
- [Shell Completions](completions.md)
- [Configuration](configuration.md)
- [Remote Caching](remote-caching.md)
- [Project Structure](project-structure.md)
- [Dependency Analyzers](analyzers.md)
    - [cpp](analyzers/cpp.md)
    - [icpp](analyzers/icpp.md)
    - [python](analyzers/python.md)
    - [markdown](analyzers/markdown.md)
    - [tera](analyzers/tera.md)
- [Processors](processors.md)
    - [Processor Types](processor-types.md)
    - [A2x](processors/a2x.md)
    - [ASCII](processors/ascii.md)
    - [Aspell](processors/aspell.md)
    - [Black](processors/black.md)
    - [Cargo](processors/cargo.md)
    - [CC](processors/cc.md)
    - [CC Single File](processors/cc_single_file.md)
    - [Checkpatch](processors/checkpatch.md)
    - [Checkstyle](processors/checkstyle.md)
    - [Chromium](processors/chromium.md)
    - [Clang-Tidy](processors/clang_tidy.md)
    - [Clippy](processors/clippy.md)
    - [CMake](processors/cmake.md)
    - [Cppcheck](processors/cppcheck.md)
    - [Cpplint](processors/cpplint.md)
    - [Doctest](processors/doctest.md)
    - [Drawio](processors/drawio.md)
    - [ESLint](processors/eslint.md)
    - [Explicit](processors/explicit.md)
    - [Gem](processors/gem.md)
    - [Generator](processors/generator.md)
    - [Hadolint](processors/hadolint.md)
    - [HTMLHint](processors/htmlhint.md)
    - [HTMLLint](processors/htmllint.md)
    - [Imarkdown2html](processors/imarkdown2html.md)
    - [Iyamlschema](processors/iyamlschema.md)
    - [Jekyll](processors/jekyll.md)
    - [Jinja2](processors/jinja2.md)
    - [Jq](processors/jq.md)
    - [JSHint](processors/jshint.md)
    - [JSLint](processors/jslint.md)
    - [Json Schema](processors/json_schema.md)
    - [Jsonlint](processors/jsonlint.md)
    - [LibreOffice](processors/libreoffice.md)
    - [Linux Module](processors/linux_module.md)
    - [Luacheck](processors/luacheck.md)
    - [Make](processors/make.md)
    - [Mako](processors/mako.md)
    - [Markdown2HTML](processors/markdown2html.md)
    - [MassGenerator](processors/mass_generator.md)
    - [Markdownlint](processors/markdownlint.md)
    - [Marp](processors/marp.md)
    - [Mdbook](processors/mdbook.md)
    - [Mdl](processors/mdl.md)
    - [Mermaid](processors/mermaid.md)
    - [Mypy](processors/mypy.md)
    - [NPM](processors/npm.md)
    - [Objdump](processors/objdump.md)
    - [Pandoc](processors/pandoc.md)
    - [Pdflatex](processors/pdflatex.md)
    - [Pdfunite](processors/pdfunite.md)
    - [Perlcritic](processors/perlcritic.md)
    - [PHP Lint](processors/php_lint.md)
    - [Pip](processors/pip.md)
    - [Protobuf](processors/protobuf.md)
    - [Pylint](processors/pylint.md)
    - [Pyrefly](processors/pyrefly.md)
    - [Pytest](processors/pytest.md)
    - [Requirements](processors/requirements.md)
    - [Ruff](processors/ruff.md)
    - [Rumdl](processors/rumdl.md)
    - [Rust Single File](processors/rust_single_file.md)
    - [Sass](processors/sass.md)
    - [Script](processors/script.md)
    - [Shellcheck](processors/shellcheck.md)
    - [Slidev](processors/slidev.md)
    - [Zspell](processors/zspell.md)
    - [Sphinx](processors/sphinx.md)
    - [Standard](processors/standard.md)
    - [Stylelint](processors/stylelint.md)
    - [Tags](processors/tags.md)
    - [Terms](processors/terms.md)
    - [Taplo](processors/taplo.md)
    - [Tera](processors/tera.md)
    - [Tidy](processors/tidy.md)
    - [XMLLint](processors/xmllint.md)
    - [Yaml2json](processors/yaml2json.md)
    - [Yamllint](processors/yamllint.md)
    - [YQ](processors/yq.md)
- [GitHub Actions](github-actions.md)
- [Lua Plugins](plugins.md)
- [Advanced Usage](advanced.md)
- [Environment Variables](environment-variables.md)
- [Release Info](release-info.md)

---

# For Maintainers

The chapters below cover the internal design and implementation of rsconstruct. They are intended for contributors and maintainers — users building projects with rsconstruct generally do not need them.

- [Internal Docs Overview](internal/README.md)
- [Architecture](internal/architecture.md)
- [Architecture Observations](internal/architecture-observations.md)
- [Design Notes](internal/design.md)
- [Coding Standards](internal/coding-standards.md)
- [Strictness](internal/strictness.md)
- [Testing](internal/testing.md)
- [Parameter Naming](internal/parameter-naming.md)
- [Processor Contract](internal/processor-contract.md)
- [Cache System](internal/cache.md)
- [Checksum Cache](internal/checksum-cache.md)
- [Dependency Caching](internal/dependency-caching.md)
- [Processor Versioning](internal/processor-versioning.md)
- [Cross-Processor Dependencies](internal/cross-processor-dependencies.md)
- [Glob-aware Tera Dependencies](internal/glob-deps.md)
- [Shared Output Directory](internal/shared-output-directory.md)
- [Processor Ordering](internal/processor-ordering.md)
- [Output Prediction](internal/output-prediction.md)
- [Per-Processor Statistics](internal/per-processor-stats.md)
- [Profiling](internal/profiling.md)
- [Fast `stat` on Linux](internal/fast-stat.md)
- [Path Interning](internal/path-interning.md)
- [Unreferenced Files](internal/unreferenced-files.md)
- [Distributed Execution](internal/distributed-execution.md)
- [Internal Processors](internal/internal-processors.md)
- [Missing Processors](internal/missing-processors.md)
- [Requirements Generator](internal/requirements-generator.md)
- [Crates.io Publishing](internal/crates-io.md)
- [Per-Processor max_jobs](internal/per-processor-max-jobs.md)
- [Plugin Registry Survey](internal/plugin-registry-survey.md)
- [Rejected Audit Findings](internal/rejected-problems.md)
- [Suggestions](internal/suggestions.md)
- [Suggestions Done](internal/suggestions-done.md)
- [TODO](internal/todo.md)
