fixed typo (paperscout-python -> paperscout)

[henry0816191]

Summary

Test plan

• ./run check (or make check)
• pre-commit run --all-files

Related issues

Summary by CodeRabbit

• Documentation
  • Updated setup, onboarding, and deployment guides to use the unified project name and new clone/start paths; clarified deploy-user and example domain placeholders.
  • Reorganized environment variable docs and added health-check variables with guidance on binding for Docker and compose.
• Chores
  • Docker Compose and deployment guidance updated so the health endpoint can be bound to all interfaces for published ports.

close #20

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d00e5950-58b6-468c-8b3a-bb19dcfe37f6

📥 Commits

Reviewing files that changed from the base of the PR and between c6ef6dd and 0894172.

📒 Files selected for processing (1)

• docs/onboarding.md

🚧 Files skipped from review as they are similar to previous changes (1)

• docs/onboarding.md

---

📝 Walkthrough

Walkthrough

Docs and deployment were rebranded to paperscout; new environment settings HEALTH_PORT and HEALTH_BIND_HOST were added and documented; the health server now accepts a bind_host parameter and the test helper updated to bind to loopback; docker-compose and deploy docs set HEALTH_BIND_HOST=0.0.0.0 for published-port access.

Changes

Repository Rebranding & Health bind_host

Layer / File(s)	Summary
Configuration / Runtime Settings .env.example, src/paperscout/config.py, README.md, docs/onboarding.md	Adds HEALTH_PORT and HEALTH_BIND_HOST to .env.example, introduces Settings.health_bind_host with default 127.0.0.1, and documents server-related env vars in README/onboarding.
Health server implementation src/paperscout/health.py, src/paperscout/__main__.py	start_health_server gains bind_host: str = "127.0.0.1" and binds HTTPServer to (bind_host, port); __main__ passes settings.health_bind_host when starting health server.
Docs, Deployment, and Compose wiring README.md, docs/onboarding.md, deploy/SERVER_SETUP.md, deploy/paperscout.conf, docker-compose.yml	Repository references changed from paperscout-python to paperscout; server setup and nginx example updated to your-domain.example.org; docker-compose sets HEALTH_BIND_HOST: "0.0.0.0" and SERVER_SETUP explains using <deploy-user> and binding considerations.
Tests / Test helpers tests/test_health.py	_find_free_port() now binds its socket to 127.0.0.1 instead of "" to allocate loopback-only ports for test servers.

Sequence Diagram(s)

sequenceDiagram
  participant DevClient
  participant MainApp
  participant HealthServer
  participant Nginx
  DevClient->>MainApp: Start app (reads Settings)
  MainApp->>HealthServer: start_health_server(port, ..., bind_host)
  HealthServer->>HealthServer: bind to (bind_host, port)
  HealthServer-->>Nginx: responds to /health requests (if reachable)
  Nginx-->>DevClient: proxied /paperscout/ and /health responses

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Suggested labels

bug

Suggested reviewers

• wpak-ai

Poem

🐰 Hopping through docs with a cheerful shout,
Paperscout now wears its new name out,
Health binds set to listen and see,
Docker opens doors for connectivity,
Deploy and dev, together we sprout! 🌱

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 66.67% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately reflects a primary change in the PR—replacing repository/project name references from 'paperscout-python' to 'paperscout'—which aligns with the substantial documentation and configuration updates throughout the changeset.
Description check	✅ Passed	The PR description uses the required template with Summary and Test plan sections included, though the Summary section is empty. A related issue reference is provided, meeting the minimum template requirements.
Linked Issues check	✅ Passed	The PR fully addresses both objectives from issue #20: it replaces 'cppdigest' references with generic placeholders (e.g., 'your-domain.example.org') and resolves the socket binding issue by implementing configurable HEALTH_BIND_HOST support across the codebase.
Out of Scope Changes check	✅ Passed	All changes directly support the stated objectives: repository name updates, removal of hardcoded user/domain references, and socket binding configuration. No unrelated modifications are present.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[wpak-ai]

I put minor comments on other naming.
Otherwise, it looks good to me.

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@deploy/SERVER_SETUP.md`:
- Around line 183-184: The clone command in the guide uses an unresolved
placeholder "<org>/<repo>" which breaks copy/paste; replace that placeholder
with the repository's actual GitHub path and update the adjacent chown command
example to use the concrete deploy user variable (e.g., the repo URL and deploy
user name used elsewhere) so readers can run the two commands as-is; locate the
lines containing the git clone and sudo chown commands and substitute the real
repo URL and a documented deploy-user value.

In `@docs/onboarding.md`:
- Line 206: The "Complete reference" section is missing the health server
environment keys; add entries for HEALTH_PORT and HEALTH_BIND_HOST to the "Slack
and server" table in the docs so the reference matches `.env.example` and the
note at line 206. In the onboarding "Slack and server" table add two rows:
HEALTH_PORT (describe purpose and default e.g., port for health endpoint) and
HEALTH_BIND_HOST (describe purpose and default e.g., bind host, typically
0.0.0.0 for Docker), keeping naming/casing consistent with the rest of the table
entries.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: fa78e3e6-8f02-4d85-88e3-e4d3bf19cdcb

📥 Commits

Reviewing files that changed from the base of the PR and between 00461fa and c6ef6dd.

📒 Files selected for processing (10)

• .env.example
• README.md
• deploy/SERVER_SETUP.md
• deploy/paperscout.conf
• docker-compose.yml
• docs/onboarding.md
• src/paperscout/__main__.py
• src/paperscout/config.py
• src/paperscout/health.py
• tests/test_health.py

✅ Files skipped from review due to trivial changes (2)

• docker-compose.yml
• tests/test_health.py