docs: add deployment & operations guide and expand docs, README and configuration reference#309
Merged
CJackHwang merged 1 commit intomainfrom Feb 28, 2026
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
Description
docs/deployment-and-operations.mdwith guidance for direct and Docker deployments,systemdexamples, maintenance commands, and upgrade recommendations.README.mdto clarify configuration default behavior, add a link to the new deployment guide, and clarify the client API key instruction.docs/README.mdto reflect the new guide and reorganize the document index.docs/api-usage.mdwith structured sections for health, chat completions, API key auth, queue management, and server management endpoints.docs/configuration-reference.mdwith detailed tables of configuration options and defaults, plus Function Calling and Cookie Refresh sections.docs/quick-start.md,docs/troubleshooting.md,docs/auth-rotation-cookie-refresh.md, anddocs/development-and-release.mdwith clearer step sequences, checks, and recommended commands.launch_camoufox.py, Docker usage, and important endpoints.Testing
poetry run ruff check .andpoetry run pyright, which passed.poetry run pytest, which completed successfully.curl http://127.0.0.1:2048/healthfor documentation accuracy.Codex Task