docs: refresh onboarding and add deployment & operations guide#308
Merged
CJackHwang merged 1 commit intomainfrom Feb 28, 2026
Merged
Conversation
|
Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
README.mdminimal and only update the documentation index as a navigational convenience.Description
docs/deployment-and-operations.mdthat explains deployment modes, production run recommendations,systemdexample, Docker instructions, maintenance commands and upgrade procedure.docs/quick-start.mdto provide a concise onboarding path: install, initial auth (--debug), daily headless run, minimum validation and a Docker quick path.docs/configuration-reference.mdinto grouped sections (Network/Ports, Launch, Auth/Rotation/Cookies, Function Calling, Logging, Timeouts, GUI) and clarified.envdefaults vs code fallbacks.docs/api-usage.mdto enumerate OpenAI-compatible endpoints plus queue/control and Web UI management APIs; improveddocs/auth-rotation-cookie-refresh.md,docs/troubleshooting.mdanddocs/development-and-release.mdwith more operational troubleshooting and CI/test guidance.docs/README.mdand added a single link in the rootREADME.mdto the new deployment guide; did not otherwise large-scale modify the root README content.Testing
poetry run pytest -qto validate documentation-only changes against the codebase.2381 collected,2371 passed,1 failed,9 skipped(full output available in CI logs).tests/integration/test_queue_disconnect.py::test_get_next_request_timeout_real_queuewhich errored withModuleNotFoundError: No module named 'api_utils.queue_worker.asyncio'; this appears unrelated to documentation edits.Codex Task