Refresh docs ahead of the v0.6.0 release#24
Merged
Conversation
The example shipped just SECRET_KEY plus three optional overrides while settings.py reads ~30 variables across Django core, database, and the S3/GCS storage backends. Group every variable in commented sections so a new operator can see what is configurable without grepping the code. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
The folder only ever held compose configuration (the root Dockerfile lives elsewhere) and CLAUDE.md already calls podman compose the canonical path, so the .docker name was misleading. Rename the folder and switch to the compose-spec filename. Both docker compose v2 and podman compose pick up compose.yml. Downstream deployment runbooks pointing at .docker/ will need an update — this is called out in the v0.6.0 release notes. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
The previous README still referenced docker-compose.yml by name and assumed nginx-proxy as a hard requirement. Point users at podman compose (matching CLAUDE.md), make the reverse-proxy expectation explicit but not prescriptive, and link the teammate onboarding flow to the post-0.5 single-use registration tokens. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
The previous README pointed at a 2022 docker run invocation and a broken production-install link. Walk through the uv-based local dev quick start (matching CLAUDE.md), point at compose/ for container deployment, and link the published user docs and the LICENSE. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
The Sphinx docs had been describing a 2022 nginx-proxy install on top of the v0.5 UI. Install, deploy, and config content now lives in README.md and compose/README.md, so docs/source becomes a pure user manual for non-developers interacting with a running instance. New structure: getting-started, projects, editor, creating-projects, analysis-and-reports, translation-memories, language-profiles, and inviting-teammates. The index notes that screenshots were captured before the v0.6.0 UI refresh and remain accurate for layout but not visual styling. Deletes: installation.rst, pre-installation-configuration.rst, try-for-free-online.rst, users.rst, and the six GCP Cloud Shell setup PNGs that supported the old installation walkthrough. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
- .dockerignore: update the path that excludes deployment config from the docker build context. - docs/source/locale/tr/: drop the four orphaned .po files whose source .rst was removed in the user-manual rewrite. The remaining Turkish .po files no longer match the new English msgids and will need regeneration via `sphinx-build -b gettext` in a follow-up. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
All eight referenced screenshots were recaptured under the Tailwind + daisyUI UI shipped in v0.6.0. Drop the index.rst note that warned readers the screenshots predated the UI refresh — it no longer applies. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Localization will move to a dedicated agentic localization service that ingests the English .rst sources directly. Maintaining stale Turkish .po files in-tree only confuses the source of truth — drop the locale/ directory entirely; the service will rehydrate translations from the canonical English when the time comes. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
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
1 participant
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.
Summary
README.mdfor the current uv/SQLite quick start and point atcompose/for container deployment..env.exampleto cover every environment variablekaplancloud/settings.pyactually reads (core Django, database, S3, GCS).docs/source/from scratch as an end-user manual for non-developers (getting started, projects, editor, creating projects, analysis and reports, TMs, language profiles, inviting teammates). Install/deploy/config content is no longer duplicated there..docker/→compose/anddocker-compose.yml→compose.yml; refreshcompose/README.mdfor the podman compose flow. Update.dockerignoreandCLAUDE.mdaccordingly..pofiles whose source.rstwas removed.A drafted set of GitHub release notes for v0.6.0 lives at
.tmp/release-notes-0.6.0.md(uncommitted) and calls out thecompose/rename for downstream deployment runbooks.Test plan
ruff check .cleanruff format --check .clean (69 files already formatted)python manage.py test— 256 tests passsphinx-build -b html docs/source /tmp/docs-buildbuilds with 9 pages and 12 screenshots.rstfiles resolves to an existing PNG in_static/img/commdiff betweenos.environ.get(...)calls insettings.pyand the entries in.env.exampleis empty in both directionsgrep -rn "\\.docker\\b\\|docker-compose\\.yml"returns only externalhub.docker.comURLs after the renamepodman compose -f compose/compose.yml configfinds and parses the renamed file (the pre-existingdefaultnetwork warning is unchanged by this PR)🤖 Generated with Claude Code