docs(readme): acknowledge dev builds where the release rule is stated - #114
Merged
Conversation
FEAT-DEV-BUILD-CHANNEL documented the channel for developers (workflow.md, building-and-testing.md) and added a sentence to the mission-maker guide, but not to the README — which is the page that tells a Mission Maker a new CTLD only arrives with a published release. Someone handed a dev exe reads that and cannot place their file. Same content as the guide's sentence: a dev build exists, it names its commit in --version, take one only when asked. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Reviewer's guide (collapsed on small PRs)Reviewer's GuideUpdates the README documentation to describe the dev build channel and how users should treat and report issues for dev builds, aligning it with existing developer and mission-maker guides. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- The relative link to the
devpre-release (../../releases/tag/dev) is likely incorrect from the root README; consider using an absolute GitHub URL or a repo-relative path like./releases/tag/dev.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The relative link to the `dev` pre-release (`../../releases/tag/dev`) is likely incorrect from the root README; consider using an absolute GitHub URL or a repo-relative path like `./releases/tag/dev`.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
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.
Why
A gap I left in
FEAT-DEV-BUILD-CHANNELand only spotted when Zip asked whether the channel was documented.The lot documented it for developers (
workflow.{md,fr.md},building-and-testing.{md,fr.md}) and added one sentence to the mission-maker guide (ctld-tools.{md,fr.md}) — but not to the README, which is precisely the page carrying "a new CTLD reaches your missions only once a release is published". Someone handed adevexe by FullGas reads that and cannot place the file they were given.What changed
Three sentences in the existing Getting a newer CTLD section, matching the guide: a dev build exists, it is unreleased and CI-tested only, it names its commit in
--version(quote it in a bug report), and it is for when someone asks you to try something.Documentation only — no
src/change, so no CHANGELOG entry.🤖 Generated with Claude Code
Summary by Sourcery
Documentation: