Docs/init

[NullPointerDepressiveDisorder]

This pull request significantly improves the project documentation, making it more user-friendly and comprehensive. The README.md has been restructured for clarity, with clearer installation, usage, and results sections, and new documentation files have been added for backends and commands. The documentation now provides better guidance for new users on getting started, understanding supported backends, and using key commands.

Documentation restructuring and improvements:

• The README.md has been reorganized for clarity: installation and quick start instructions are now more prominent, usage examples are streamlined, and command documentation is summarized in a table with links to detailed docs. The example results and backend descriptions have been rewritten for conciseness and practical guidance. [1] [2] [3] [4]

New documentation files:

• Added docs/backends.md with detailed descriptions, setup instructions, and usage examples for each supported backend (mlx-lm, llama.cpp, vllm-mlx, and openai-compat). This helps users select and configure the right backend for their use case.
• Added command-specific documentation for compare and determinism in docs/commands/compare.md and docs/commands/determinism.md, including CLI usage, workflow explanations, examples, and output formats. [1] [2]

Project visibility and discoverability:

• Added badges for code coverage and documentation to the top of the README.md for improved project visibility.

Overall, these changes make the documentation more accessible, guide users through common workflows, and provide clear references for all major features and commands.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[Copilot]

Pull request overview

This PR introduces an MkDocs-based documentation site for infer-check and refreshes the top-level README to point users to more comprehensive, task-focused docs.

Changes:

• Added mkdocs.yml plus custom CSS and a full docs/ tree (getting started, commands reference, backends, and results interpretation).
• Added per-command documentation pages (sweep, compare, diff, determinism, stress, report) with CLI reference blocks and examples.
• Restructured README.md with badges, quick start, a command table linking to docs, and streamlined examples.

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
mkdocs.yml	Adds MkDocs Material configuration, nav structure, and Markdown extensions for the docs site.
docs/stylesheets/extra.css	Defines custom primary colors for dark/light schemes.
docs/index.md	Adds a docs-site landing page with problem statement, command overview, and quick start.
docs/getting-started.md	Provides installation, global options, first test walkthrough, prompt suites, and model resolution rules.
docs/backends.md	Documents supported backends, setup, and endpoint mode guidance.
docs/interpreting-results.md	Explains severity tiers, flip rate, KL divergence, and how to read summary tables.
docs/commands/sweep.md	Documents sweep workflow, CLI reference embedding, and output format.
docs/commands/compare.md	Documents compare workflow, prefixes, examples, and output semantics.
docs/commands/diff.md	Documents diff workflow, base URL matching, examples, and output format.
docs/commands/determinism.md	Documents determinism testing workflow and how to interpret results.
docs/commands/stress.md	Documents concurrency stress testing workflow and what to look for.
docs/commands/report.md	Documents report generation behavior, examples, and notes.
README.md	Adds badges + docs link, reorganizes usage into quick start + commands table, and trims/streamlines examples.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.