Docs lockstep, ignore graphify-out - #5
Merged
Conversation
The published run commands could not be run from a fresh machine: compose.yaml is `build: .`, so `docker compose up --build` needed a checkout that no page mentioned. Quickstart and Deployment now lead with compose.prod.yaml, which pulls the published image, and keep the build path as the contributor route. Fix the DOCKER_GID advice. The docs told macOS readers to run `stat -f %g` on the host, but /var/run/docker.sock there is a symlink into ~/.docker and reports a group that means nothing inside the container, where the socket is gid 0. Both Deployment and Troubleshooting now read the gid from inside the container and name 0 as the Docker Desktop answer. Surface max_concurrent_jobs. It defaults to 1, has no env var, and can only be raised after first boot, which is a sizing constraint people should meet before installing rather than after. Configuration leads with it. Correct max_workspace_bytes, which was documented as a checkout size cap. It is accepted, stored, and editable, and no code reads it. Add Operations: what state is, cold backup and restore, what a restart does to a running job, the upgrade procedure, and the migration policy. A restart does not preserve in-flight work; the job is requeued and re-run from the start, or occasionally lands cancelled and is not retried. Restore has to write into the volume rather than through `docker compose cp`, which copies as root and leaves the database unwritable to uid 10001. Add Comparison against Woodpecker, Drone, self-hosted actions/runner, and Jenkins, including the cases where the reader should pick one of those, and a plain list of where this is weaker. Add FAQ entries for GitHub Enterprise Server, monorepos, whether the project dogfoods itself, and what v1 commits to. The compatibility promise itself is left as a TODO because it is a decision, not a fact about the code. Move Coolify below Enable repos in the sidebar and retitle it so the nav stops implying it is a required step 2 of 3. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Nine variants of the product description were in circulation across the four
repositories. They collapse to two strings, used verbatim:
tagline A small CI provider for private repos.
description A small CI provider for private repos. One Go binary, one
SQLite file: register a GitHub App, enable your repos, and get
one Check Run per commit.
The description opens with the tagline so the two cannot drift, and fits a meta
description, an OG description, and a GitHub repo description without being
truncated.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
…mise Shutdown is no longer a race. Operations now describes two outcomes chosen by how the process died: a signal leaves in-flight jobs cancelled and not retried, a kill leaves them requeued and re-run from the start. Notes the stop_grace_period both compose files set. max_workspace_bytes is gone from the product, so it goes from the settings table. Operations says plainly that there is no checkout size cap and how to size WORKSPACE_DIR instead. Remove the "What does v1 commit to?" entry and its TODO. The facts it collected live in Operations and the API reference; the compatibility promise itself is not written yet and a half-answer is worse than no entry. Remove the demo link from Logs, which pointed at a website section that no longer exists. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
The docs repo is not a graphify workspace; that output belongs at the workspace root only. Co-authored-by: Cursor <cursoragent@cursor.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
max_workspace_bytesremoval.graphify-out/— this repo is not a graphify workspace.mainso the Logs demo line from Point Logs at the marketing demo section #4 is kept.Test plan
npm run buildandnpm run check-links#demosectiongraphify-out/is not trackedMade with Cursor