# 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)
- [sass](analyzers/sass.md)
- [tera](analyzers/tera.md)
- [Processors](processors.md)
- [Processor Types](processor-types.md)
- [Checkers](processor/checker/README.md)
- [Actionlint](processor/checker/actionlint.md)
- [ASCII](processor/checker/ascii.md)
- [Aspell](processor/checker/aspell.md)
- [Biome](processor/checker/biome.md)
- [Black](processor/checker/black.md)
- [Checkpatch](processor/checker/checkpatch.md)
- [Checkstyle](processor/checker/checkstyle.md)
- [Clang-Tidy](processor/checker/clang_tidy.md)
- [Clippy](processor/checker/clippy.md)
- [CMake](processor/checker/cmake.md)
- [Cppcheck](processor/checker/cppcheck.md)
- [Cpplint](processor/checker/cpplint.md)
- [Doctest](processor/checker/doctest.md)
- [Duplicate Files](processor/checker/duplicate_files.md)
- [Encoding](processor/checker/encoding.md)
- [ESLint](processor/checker/eslint.md)
- [Hadolint](processor/checker/hadolint.md)
- [HTMLHint](processor/checker/htmlhint.md)
- [HTMLLint](processor/checker/htmllint.md)
- [Iactionlint](processor/checker/iactionlint.md)
- [Icpplint](processor/checker/icpplint.md)
- [Idockerfile](processor/checker/idockerfile.md)
- [Ijq](processor/checker/ijq.md)
- [Ijsonlint](processor/checker/ijsonlint.md)
- [Iluacheck](processor/checker/iluacheck.md)
- [Isvglint](processor/checker/isvglint.md)
- [Itaplo](processor/checker/itaplo.md)
- [Itidy](processor/checker/itidy.md)
- [Ixmllint](processor/checker/ixmllint.md)
- [Iyamllint](processor/checker/iyamllint.md)
- [Iyamlschema](processor/checker/iyamlschema.md)
- [Iyq](processor/checker/iyq.md)
- [Jq](processor/checker/jq.md)
- [JSHint](processor/checker/jshint.md)
- [JSLint](processor/checker/jslint.md)
- [Json Schema](processor/checker/json_schema.md)
- [Jsonlint](processor/checker/jsonlint.md)
- [License Header](processor/checker/license_header.md)
- [Luacheck](processor/checker/luacheck.md)
- [Make](processor/checker/make.md)
- [Markdownlint](processor/checker/markdownlint.md)
- [Marp Images](processor/checker/marp_images.md)
- [Mdl](processor/checker/mdl.md)
- [Mypy](processor/checker/mypy.md)
- [Oxlint](processor/checker/oxlint.md)
- [Perlcritic](processor/checker/perlcritic.md)
- [PHP Lint](processor/checker/php_lint.md)
- [Prettier](processor/checker/prettier.md)
- [Pylint](processor/checker/pylint.md)
- [Pyrefly](processor/checker/pyrefly.md)
- [Pytest](processor/checker/pytest.md)
- [Ruff](processor/checker/ruff.md)
- [Rumdl](processor/checker/rumdl.md)
- [Script](processor/checker/script.md)
- [Selene](processor/checker/selene.md)
- [Shellcheck](processor/checker/shellcheck.md)
- [Slidev](processor/checker/slidev.md)
- [Standard](processor/checker/standard.md)
- [Stylelint](processor/checker/stylelint.md)
- [Svglint](processor/checker/svglint.md)
- [Svgo](processor/checker/svgo.md)
- [Taplo](processor/checker/taplo.md)
- [Terms](processor/checker/terms.md)
- [Tidy](processor/checker/tidy.md)
- [XMLLint](processor/checker/xmllint.md)
- [Yamllint](processor/checker/yamllint.md)
- [YQ](processor/checker/yq.md)
- [Zspell](processor/checker/zspell.md)
- [Generators](processor/generator/README.md)
- [A2x](processor/generator/a2x.md)
- [CC Single File](processor/generator/cc_single_file.md)
- [Chromium](processor/generator/chromium.md)
- [Drawio](processor/generator/drawio.md)
- [Generator](processor/generator/generic.md)
- [Ijinja2](processor/generator/ijinja2.md)
- [Imarkdown2html](processor/generator/imarkdown2html.md)
- [Ipdfunite](processor/generator/ipdfunite.md)
- [Iprotobuf](processor/generator/iprotobuf.md)
- [Isass](processor/generator/isass.md)
- [Jinja2](processor/generator/jinja2.md)
- [LibreOffice](processor/generator/libreoffice.md)
- [Mako](processor/generator/mako.md)
- [Markdown2HTML](processor/generator/markdown2html.md)
- [Marp](processor/generator/marp.md)
- [Mermaid](processor/generator/mermaid.md)
- [Objdump](processor/generator/objdump.md)
- [Pandoc](processor/generator/pandoc.md)
- [Pdflatex](processor/generator/pdflatex.md)
- [Pdfunite](processor/generator/pdfunite.md)
- [Protobuf](processor/generator/protobuf.md)
- [Requirements](processor/generator/requirements.md)
- [Rust Single File](processor/generator/rust_single_file.md)
- [Sass](processor/generator/sass.md)
- [Tags](processor/generator/tags.md)
- [Tera](processor/generator/tera.md)
- [Yaml2json](processor/generator/yaml2json.md)
- [Creators](processor/creator/README.md)
- [Cargo](processor/creator/cargo.md)
- [CC](processor/creator/cc.md)
- [Creator](processor/creator/generic.md)
- [Gem](processor/creator/gem.md)
- [Jekyll](processor/creator/jekyll.md)
- [Linux Module](processor/creator/linux_module.md)
- [Mdbook](processor/creator/mdbook.md)
- [NPM](processor/creator/npm.md)
- [Pip](processor/creator/pip.md)
- [Sphinx](processor/creator/sphinx.md)
- [Explicit](processor/explicit/README.md)
- [Explicit](processor/explicit/generic.md)
- [Mass Generators](processor/mass_generator/README.md)
- [Mass Generator](processor/mass_generator/generic.md)
- [Zola](processor/mass_generator/zola.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)
- [No-Shell Policy](internal/no-shell-policy.md)
- [Download Policy](internal/download-policy.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)
- [Routing Generated Files](internal/output-routing.md)
- [Undeclared Reads](internal/undeclared-reads.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)