📝 Improve public repository readiness

[nbsp1221]

Summary

• Rework the README into a public-facing landing page with badges, prerequisites, npm installation, a focused quick start, workspace guidance, and links to canonical technical documentation.
• Add repository community-health documentation and templates for contributions, security reports, conduct expectations, bug reports, feature requests, and pull requests.
• Refresh the test documentation to match the current CLI-oriented test surface.

Verification

• pnpm format:check && pnpm lint && pnpm typecheck — passed with no lint warnings or errors.
• vitest run --project unit --project integration — 40 tests across 11 files passed.
• tsdown — production CLI bundle built successfully.
• npm pack plus a temporary global install — the packaged chat2shell --help command ran successfully.
• Documentation checks — local Markdown links resolve and the README renders successfully through GitHub's GFM renderer.

Notes

This change is documentation and repository metadata only; it does not change runtime behavior.

[leverframe]

Leverframe review

🟡 Review completed in 371s

• 1 finding
• 9 of 9 changed files reviewed
• Verification: 6 passed

Changes 3169bd9..a24a700 · Commit a24a700 · Open review · View check run

[leverframe]

Leverframe review

One low-severity documentation defect found. Review used the repository-pinned pnpm 11.23.0 with Node v24.20.0. The full prescribed quality gate passed, and all changed files were materially inspected.

Findings

1 finding was published inline.

Checks

6 passed · 0 failed · 0 not run

Show 6 checks

Status	Check	Evidence
🟢 passed	git diff --check 3169bd993f8492089316aecf6a2c1e6e39dc21ec...a24a70069534d36a72f65283d7780b068ffc39f6	No whitespace errors.
🟢 passed	pnpm install --frozen-lockfile	Installed 329 packages using repository-pinned pnpm 11.23.0 under Node v24.20.0; lockfile and supply-chain policy verification passed.
🟢 passed	pnpm check	Formatting, oxlint/eslint, TypeScript, 11 unit/integration test files with 40 tests, and the Node 24 production build all passed.
🟢 passed	pnpm dlx yaml --json --single --strict ... | jq ...	Both issue forms and the issue-template configuration parsed as strict YAML and satisfied their required structural constraints.
🟢 passed	Local Markdown target check and curl checks for added external URLs	All local links resolve. The OpenAI tunnel guide, Docker Sandboxes documentation, CI workflow/badge, and badge endpoints responded successfully; the new SECURITY.md link resolves at the reviewed head SHA.
🟢 passed	pnpm pack --dry-run	Produced a valid chat2shell@0.2.0 package manifest containing the built CLI and documented package files.

Limitations

• Docker Sandboxes (sbx) was unavailable, so the real E2E suite was not run. No sandbox/runtime code changed, and repository guidance assigns this documentation-only change to the normal pnpm check boundary.

[leverframe]

🔵 [LOW] The advertised complete environment template omits a supported override

This newly claims that .env.example contains every environment override, but loadAppConfig reads CHAT2SHELL_DATABASE_PATH and that variable is absent from both .env.example and the new configuration table. Users relying on the promised exhaustive template cannot discover or reproduce deployments that place the SQLite database separately from the state directory.

Evidence: src/config.ts:68-70 resolves environment.CHAT2SHELL_DATABASE_PATH, while .env.example contains nine other CHAT2SHELL_* variables but no database-path entry.

Suggested action: Add CHAT2SHELL_DATABASE_PATH to .env.example and document it in the table, or qualify the completeness claim and identify where all supported overrides are documented.

Confidence: high