Terminal interface to find, download, and stream movies, TV shows, and live TV using local media players.
docs: single canonical contributing doc, clarify readme roles
Samir Hossains63edebefa9d8
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.mdindex 48122df..1b44615 100644--- a/CONTRIBUTING.md+++ b/CONTRIBUTING.md@@ -27,16 +27,23 @@ To test playback and download features locally, install `mpv` (see the [README](## Project layout-The app is divided into three core layers: UI, Providers, and Core Utilities.+The app is message-driven and organized into focused modules. Full maps live in+[`docs/architecture.md`](docs/architecture.md) and [`docs/modules.md`](docs/modules.md).Short version:-- `src/tui/`: The terminal interface, built on Ratatui.- - `src/tui/app.rs`: The central event loop. Every user action and background task funnels through its `match` statement. This is the best place to start reading.-- `src/providers/`: HTTP clients for various streaming sources (`moviebox`, `bdix`, `fourkhdhub`, `iptv_org`).-- `src/download.rs`: Handles background media downloading.-- `src/cache.rs`: Local disk caching system to minimize API calls.--The app is message-driven. User input and background tasks produce `Action` values, handled in `app.rs`. When adding behavior, prefer adding a new `Action` variant over blocking the UI thread.+- `src/tui/app/`: The application object (`App`). `mod.rs` holds the thin `handle_action`+ dispatcher that routes every `Action` to a `handle_*` method in its module+ (`run.rs`, `requests.rs`, `playback.rs`, `download.rs`, `navigation.rs`, `tv.rs`,+ `system.rs`, `keyboard.rs`, `network.rs`).+- `src/tui/`: UI state, event loop plumbing, player commands, screens, themes.+- `src/providers/`: HTTP clients for the streaming sources (`moviebox`, `fourkhdhub`,+ `bdix`), plus `m3u.rs` for TV playlists.+- `src/download.rs`: Background media downloading.+- `src/cache.rs`: Local disk caching to minimize API calls.++The app is message-driven. User input and background tasks produce `Action` values,+handled by the dispatcher in `src/tui/app/mod.rs`. When adding behavior, prefer adding a+new `Action` variant over blocking the UI thread.## Workflowdiff --git a/README.md b/README.mdindex 69ce8df..89589dc 100644--- a/README.md+++ b/README.md@@ -15,9 +15,10 @@ Search, browse, play, and download movies, series, anime, and IPTV streams from## Documentation-The [`docs/`](docs/README.md) folder contains detailed documentation — architecture,-providers, players, cache, logging, TV mode, configuration, and debugging — written so-anyone can understand the project without reading the whole codebase.+This README is the project landing page (features, install, usage). The full+documentation set — architecture, providers, players, cache, logging, TV mode,+configuration, and debugging — lives in [`docs/`](docs/README.md). Contribution+guidance is in [`CONTRIBUTING.md`](CONTRIBUTING.md).## Featuresdiff --git a/docs/README.md b/docs/README.mdindex 5dd8740..e089238 100644--- a/docs/README.md+++ b/docs/README.md@@ -19,8 +19,10 @@ anchors that stay accurate as the code evolves.| [downloads.md](downloads.md) | Download engine: resume, ranges, segments, retry, cancel | current || [cross-platform.md](cross-platform.md) | OS support, terminal protocols, Termux, focus handling | current || [debugging.md](debugging.md) | Reproducing issues and what to include in GitHub reports | current |-| [contributing.md](contributing.md) | Build, lint gate, commit conventions | current || [known-issues.md](known-issues.md) | Known limitations and how they are tracked | current |+> Contribution guidance lives in the repository-root `CONTRIBUTING.md` (the canonical+> doc GitHub surfaces for PRs), not in this folder.+> Keep this index accurate: when a behavior change lands, update the matching doc in> the same change and flip its status to current.diff --git a/docs/contributing.md b/docs/contributing.mddeleted file mode 100644index 6f7614d..0000000--- a/docs/contributing.md+++ /dev/null@@ -1,56 +0,0 @@-# Contributing--## Requirements--- Rust 1.90+ (`rust-version` in Cargo.toml).-- `cargo` with `fmt` and `clippy` components.--## Build--```bash-cargo build # debug-cargo build --release # release (lto, strip)-```--## Development loop--```bash-cargo fmt # format-cargo clippy --all-targets -- -D warnings # lint (must be clean)-cargo build-cargo test --lib-```--The repository's pre-commit hook runs `cargo fmt` and-`cargo clippy --all-targets -- -D warnings`; a commit is rejected if either fails.--## Running--`moviebox-tui` needs an interactive terminal (raw mode + alternate screen). For logs,-see [logging.md](logging.md); `MOVIEBOX_LOG=info` is handy during development.--## Structure--The crate is organized into focused modules; `docs/modules.md` and-`docs/architecture.md` are the map. `tui/app/` holds the application object: `mod.rs`-is the thin `handle_action` dispatcher, and each `handle_*` method lives in its own-module (`requests`, `playback`, `download`, `navigation`, `tv`, `system`, `keyboard`).--## Commit conventions--- Conventional Commits: `feat(scope): …`, `fix(scope): …`, `refactor(scope): …`,- `docs(scope): …`, `chore(scope): …`.-- Keep changes focused; one logical change per commit.-- Refactors must be behavior-neutral (bodies moved verbatim) and pass the gate.-- When a change surfaces an error, fix it in a follow-up commit rather than amending,- so the history documents the find and the fix.--## Documentation--- Keep `docs/` up to date with the code. Update the relevant topic doc in the same- change that alters behavior, and keep `docs/README.md`'s status column accurate.--## CI--`.github/workflows/ci.yml` runs fmt, clippy (`-D warnings`), `cargo audit`, and-`cargo package` on macOS, Linux, and Windows.