Add Boost Endpoint API Documentation and Update README.md

[AuraMindNest]

Close #36.
Close #38.

Summary by CodeRabbit

• Documentation
  • Expanded README.md with comprehensive guidance covering Weblate plugin configuration options, architecture details, endpoint routes and registration, and updated contribution workflow information.
  • Added new Boost Endpoint API documentation with detailed specifications for all endpoints, complete request/response schemas, authentication requirements, validation rules, error handling, and practical examples.

[coderabbitai]

Warning

Rate limit exceeded

@AuraMindNest has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 55 minutes and 6 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 37972c6e-f466-4428-8041-f60567b5ef6d

📥 Commits

Reviewing files that changed from the base of the PR and between e1c3f6c and fed34e9.

📒 Files selected for processing (2)

• README.md
• docs/boost-endpoint-api.md

📝 Walkthrough

Walkthrough

This PR expands documentation for the Weblate plugin by updating README.md with architecture, configuration, and routes guidance, and introducing a dedicated API reference document (docs/boost-endpoint-api.md) that covers endpoint contracts, schemas, async execution, and service internals.

Changes

Weblate Plugin Configuration and API Documentation

Layer / File(s)	Summary
Architecture and Configuration Setup README.md	Expanded architecture section to show endpoint and Celery boundaries; clarified WEBLATE_FORMATS configuration via Docker override; added WEBLATE_ADD_APPS section with dual configuration approaches and duplicate-registration warning; provided guidance for implementing additional formats using the adapter/util split pattern.
HTTP Routes and Endpoint Reference README.md, docs/boost-endpoint-api.md	Listed three /boost-endpoint/ routes and explained explicit registration via BoostEndpointConfig.ready(); documented plugin-ping health check, info metadata, and POST /boost-endpoint/add-or-update/ endpoint; defined request/response JSON schemas, validation rules, example payloads, authentication requirements, and error responses.
Async Execution and Service Pipeline docs/boost-endpoint-api.md	Documented HTTP-to-Celery dispatch flow with user identity serialization and task exception handling; detailed BoostComponentService per-submodule processing steps (clone, scan, permission checks, get-or-create, sync, language add, stale deletion); specified non-fatal error collection and component naming rules with deterministic hash suffix for length constraints.
Contributing Section Updates README.md	Updated CI and coverage documentation to reflect terminal output, XML/HTML artifacts, pyproject.toml configuration, and uv sync groups usage.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 A rabbit hops through docs so bright,
New routes and schemas, all in sight,
The Celery garden blooms with care,
Async flows drift through the air,
Configuration clear—no need to fret! 📚

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely summarizes the main changes: adding Boost Endpoint API documentation and updating the README with relevant details.
Linked Issues check	✅ Passed	The PR addresses all acceptance criteria from both linked issues: documentation of three endpoints with auth/schemas [#36], async execution model, BoostComponentService internals, and README updates covering WEBLATE_ADD_APPS, routes, and Celery details [#38].
Out of Scope Changes check	✅ Passed	All changes are within scope: README.md updates and the new docs/boost-endpoint-api.md directly fulfill the linked issues' documentation requirements with no extraneous alterations.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[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 `@docs/boost-endpoint-api.md`:
- Around line 78-80: Several fenced code blocks in docs/boost-endpoint-api.md
are missing language labels; update each unlabeled block (e.g., the request
example "GET /boost-endpoint/plugin-ping/", the response example starting with
"HTTP/1.1 200 OK", the flow diagram block beginning "POST
/boost-endpoint/add-or-update/" and the filename→slug example
"doc/html/intro.adoc  →  \"doc-html-intro-adoc\"") to include appropriate
language tags: use ```http for HTTP request/response examples and ```text for
flow diagrams and filename→name/slug examples; apply the same change to other
occurrences noted (lines around 84-89, 99-102, 106-115, 131-135, 280-300,
381-383, 387-389).

In `@README.md`:
- Around line 215-233: The fenced code block that documents the request→Celery
flow (starting with "POST /boost-endpoint/add-or-update/" and showing
AddOrUpdateView.post() and boost_add_or_update_task.delay(...)) is missing a
language tag and triggers markdownlint MD040; fix it by changing the opening
triple-backtick fence to include a language (e.g., use ```text) so the block
becomes a fenced "text" code block while leaving the contents and closing triple
backticks unchanged.

🪄 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: 8c4d6a1f-22c2-4e4e-9576-8603079c1c57

📥 Commits

Reviewing files that changed from the base of the PR and between d6c55ad and e1c3f6c.

📒 Files selected for processing (2)

• README.md
• docs/boost-endpoint-api.md

[AuraMindNest]

@coderabbitai resume

[coderabbitai]

✅ Actions performed

Reviews resumed.