docs: make the public documentation minimal

Signed-off-by: faratech <35661811+faratech@users.noreply.github.com>

Author: faratech

ARCHITECTURE.md

@@ -1,59 +1,20 @@
-# Contributing to httpjet
+# Contributing
 
-Thank you for helping improve httpjet. Bug reports, documentation fixes,
-tests, and focused code changes are welcome.
-
-## Before opening a change
-
-- Search existing issues and pull requests.
-- Keep changes narrowly scoped. Security-sensitive behavior, protocol
-  compatibility, and cache correctness need regression tests.
-- Do not include credentials, production data, private configuration,
-  customer content, or generated artifacts derived from them.
-- Discuss large architectural changes in an issue before investing in an
-  implementation.
-
-## Development checks
-
-httpjet currently targets Linux and Rust 1.97 or newer.
+Keep changes focused, add regression tests, and never include secrets,
+production data, or private configuration.
 
 ```bash
 cargo fmt --all --check
 cargo check -p httpjet --bin httpjet
-cargo check -p httpjet --bin httpjet --features profiling
 cargo test --workspace
 ```
 
-Tests marked `ignored` can depend on local software or configuration. Do not
-run them against a production installation.
-
-## Developer Certificate of Origin
-
-Contributions use the [Developer Certificate of Origin](DCO), not a
-copyright-assignment or commercial-relicensing CLA. Sign every commit:
+Sign every commit under the [Developer Certificate of Origin](DCO):
 
 ```bash
 git commit -s
 ```
 
-The sign-off certifies the statements in [DCO](DCO). It must use a name and
-email address you are authorized to submit publicly. Pull requests with
-unsigned commits will be asked to add sign-offs.
-
-Contributions are licensed under `GPL-3.0-only`. FaraTech does not receive a
-special right to relicense community contributions under proprietary terms.
-
-## AI-assisted contributions
-
-You remain responsible for every line you submit. Disclose material use of a
-generative tool in the pull request, review the output, and confirm that you
-have the right to contribute it. Never send private repository content,
-credentials, production data, or third-party confidential material to a tool
-that is not approved to receive it.
-
-## Pull requests
-
-Explain the problem, the intended behavior, operational impact, and checks
-run. Avoid drive-by formatting or dependency changes unrelated to the fix.
-Preserve third-party license notices and add provenance for newly vendored
-code.
+Contributions are GPL-3.0-only; there is no proprietary-relicensing CLA.
+Disclose material AI assistance in the pull request and remain responsible for
+the submitted code and its provenance.

CONTRIBUTING.md

@@ -1,152 +1,45 @@
 # httpjet
 
-httpjet is an experimental, high-performance Rust web server for Linux. It is
-designed as a drop-in replacement for the parts of LiteSpeed Web Server used by
-an existing deployment: it reads the same XML configuration, speaks LSAPI to
-`lsphp`, and implements HTTP/1.1, HTTP/2, HTTP/3, TLS, rewrite rules, reverse
-proxying, static files, and an opt-in origin page cache.
+httpjet is an experimental Linux web server written in Rust. It reads
+LiteSpeed-compatible XML, speaks LSAPI to `lsphp`, and supports H1/H2/H3, TLS,
+static files, proxying, rewrites, compression, and an opt-in page cache.
 
-> **Status: 0.1.0, early-stage.** FaraTech runs httpjet in production, but the
-> project has been developed against a specific configuration and is not a
-> claim of complete LiteSpeed compatibility. Stage it on alternate ports,
-> review the security model, and test every required directive before a
-> cutover.
+It is early-stage software built around one production configuration. Test on
+alternate ports before using it elsewhere.
 
-httpjet is completely open source under
-[GPL-3.0-only](LICENSE). There is no paid edition, license key, or
-sponsor-only feature set. Sponsorship supports maintenance but does not change
-the software license or feature access.
+## Build and try it
 
-## Current scope
-
-- **LiteSpeed XML compatibility** — reads `conf/httpd_config.xml`,
-  `conf/vhosts/*.xml`, `mime.properties`, and supported `.htaccess` directives.
-- **Linux io_uring transport** — per-core monoio runtimes serve H1, native
-  H2/h2c, TLS H1/H2, and quinn-proto-backed H3.
-- **Native LSAPI** — LSAPI codec, owned `lsphp` supervision, and an optional
-  independently supervised external pool.
-- **TLS with rustls** — SNI certificates and optional client-certificate
-  verification from the imported listener configuration.
-- **Static, proxy, rewrite, and compression** — ranges and conditionals,
-  HTTP/WebSocket/SSE proxying, Apache-style rewrite rules, gzip, Brotli, and
-  zstd.
-- **Origin page cache** — opt-in, sharded cache with private variants,
-  stale handling, tag purge, optional tmpfs persistence, and dictionary
-  compression.
-
-The current release does **not** have a native TOML configuration format or
-automatic configuration migration command. `--root` always names a
-LiteSpeed-compatible configuration tree.
-
-## Requirements
-
-- Linux with io_uring support
-- Rust 1.97 or newer
-- A LiteSpeed-compatible XML configuration tree
-- Optional: an LSAPI-compatible `lsphp` binary for PHP sites
-
-The workspace crates are source components of the application and currently
-set `publish = false`; they are not published independently to crates.io.
-
-## Build
+Requires Linux with io_uring and Rust 1.97+.
 
 ```bash
 git clone https://github.com/faratech/httpjet.git
 cd httpjet
 cargo build --release -p httpjet
-```
-
-The binary is `target/release/httpjet`.
-
-## Try the static example
-
-The repository includes a self-contained, HTTP-only example on
-`127.0.0.1:8080`:
-
-```bash
-target/release/httpjet --root "$(pwd)/examples/litespeed" check --strict
-target/release/httpjet --root "$(pwd)/examples/litespeed" serve \
-  --http-addr 127.0.0.1:8080 \
-  --https-addr "" \
-  --workers 1 \
-  --no-php
-```
-
-Then request it with:
-
-```bash
+target/release/httpjet --root "$PWD/examples/litespeed" check --strict
+target/release/httpjet --root "$PWD/examples/litespeed" serve \
+  --http-addr 127.0.0.1:8080 --https-addr "" --workers 1 --no-php
 curl -H 'Host: example.test' http://127.0.0.1:8080/
 ```
 
-`--no-php` is appropriate only for a configuration that cannot expose PHP
-source files. Do not add PHP content to this static example.
+Use `--root` with an existing LiteSpeed configuration tree. Run
+`httpjet serve --help` for runtime options.
 
-For an existing installation, validate its configuration before serving:
+## Development
 
-```bash
-httpjet --root /path/to/litespeed check --strict
-httpjet --root /path/to/litespeed serve \
-  --http-addr 127.0.0.1:8080 \
-  --https-addr 127.0.0.1:4443 \
-  --workers 1 \
-  --no-mtls \
-  --php-socket /tmp/httpjet-test-lsphp.sock \
-  --php-children 2
-```
-
-Use alternate ports and a non-production PHP socket until application,
-protocol, cache, and rollback testing is complete. `--no-mtls` is for explicit
-local testing only.
-
-## Test
+The `httpjet` binary is under `crates/httpjet`; reusable components are the
+`hj-*` crates.
 
 ```bash
 cargo fmt --all --check
 cargo check -p httpjet --bin httpjet
-cargo check -p httpjet --bin httpjet --features profiling
 cargo test --workspace
 ```
 
-Ignored tests can depend on local software or configuration and must be invoked
-separately. The profiling feature exposes raw pprof data for external tools; it
-does not bundle a flamegraph renderer.
-
-## Architecture
-
-The workspace contains one binary crate and fourteen `hj-*` libraries. See
-[ARCHITECTURE.md](ARCHITECTURE.md) for the dependency map and request
-pipeline.
-
-## Installation
-
-[packaging/systemd](packaging/systemd) contains an unprivileged, static-only
-example service for the bundled configuration. It deliberately listens on
-port 8080 and enables neither TLS, PHP, nor the page cache. Production policy
-belongs in a reviewed local unit or drop-in.
-
-## Contributing and security
-
-Contributions use DCO sign-offs and are accepted under GPL-3.0-only; FaraTech
-does not require a proprietary-relicensing CLA. See
-[CONTRIBUTING.md](CONTRIBUTING.md).
-
-Report vulnerabilities privately as described in [SECURITY.md](SECURITY.md).
-Third-party attributions are in [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).
-
-## Sponsorship
-
-Donations are optional support for maintenance. They do not buy private
-features, support obligations, or influence over the roadmap. Funding links
-will appear in GitHub's **Sponsor** button when enrollment is enabled.
-
-## License and names
-
-Copyright © FaraTech.
+See [CONTRIBUTING.md](CONTRIBUTING.md), [SECURITY.md](SECURITY.md), and
+[THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).
 
-FaraTech-owned code and documentation are licensed under
-[GNU GPL version 3 only](LICENSE). Third-party components retain their own
-licenses.
+Donations support maintenance only; they do not buy features or influence.
+Funding links will appear in GitHub's Sponsor button when enabled.
 
-LiteSpeed and OpenLiteSpeed are names of their respective owners. httpjet is
-an independent project and is not affiliated with or endorsed by LiteSpeed
-Technologies.
+httpjet is [GPL-3.0-only](LICENSE), with no paid edition or license key. It is
+independent of and not endorsed by LiteSpeed Technologies.

README.md

@@ -1,22 +1,8 @@
-# Security policy
+# Security
 
-## Supported versions
+Use GitHub's private vulnerability reporting from this repository's
+**Security** tab. Do not disclose suspected vulnerabilities in public issues.
 
-Until httpjet reaches a stable release, security fixes are made on the latest
-`main` branch only. There is no long-term-support release line yet.
-
-## Reporting a vulnerability
-
-Please use GitHub's private vulnerability reporting flow from the repository's
-**Security** tab. Do not open a public issue for a suspected vulnerability.
-
-Include the affected revision, a minimal reproduction, expected impact, and
-any suggested mitigation. Please avoid accessing data that is not yours,
-disrupting services, or testing against installations without permission.
-
-We will acknowledge a usable report as soon as practical, investigate it, and
-coordinate disclosure after a fix is available. This project does not
-currently operate a paid bug-bounty program.
-
-Operational questions and ordinary hardening suggestions can use public
-issues when they do not disclose an exploitable weakness.
+Include the affected revision, reproduction, and impact. Test only systems you
+own or have permission to test. Security fixes target the latest `main`; there
+is no paid bounty or LTS branch.