Repository navigation
docs: Restructure docs around Craft concepts instead of targets - #935
Merged
Merged
Conversation
Release workspaces were documented under the GitHub target even though they are a top-level Craft feature. Reorganize the site into Start Here, Guides, Targets, and Reference sections, give workspaces, versioning, changelogs, AI summaries, the release workflow, and the CLI their own pages, and fix stale or incorrect content found along the way. Co-Authored-By: Burak Yigit Kaya <126780+BYK@users.noreply.github.com>
Contributor
|
BYK
approved these changes
Oct 27, 2026
8 tasks done
This branch was successfully deployed
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.
Release workspaces were documented under the GitHub target, even though they're a top-level Craft feature. The rest of the site had the same problem:
configuration.mdwas a ~900-line catch-all, andgetting-started.mdmixed installation, CLI help dumps, versioning, dry-run, and project setup.New sidebar
/getting-started/, rewritten as a setup-and-first-release walkthrough).craft.ymlkey, plus aminVersionfeature-gate table) and CLI (commands, global options, env vars, dry-run)Most content was moved as-is. These are the corrections I made along the way:
onlyIfPresentwas listed as a per-target option, but only theregistrytarget supports it.workspace,craft_version,llm, andllm_api_keyinputs and the action-onlychangelog_fileandissue_urloutputs. They also claimed the action and the workflow have identical outputs, which isn't true.categoriesin.craft.yml. That schema ignores them; categories belong in.github/release.yml. I removed it and linked to the Changelogs page instead.minVersion2.19.0. The code gate is 2.21.0. It also usedactions/upload-artifact@v2, which is retired.autowhenminVersionis 2.14.0 or later,manualotherwise.packages/*glob with onetagPrefix. Every directory a glob matches gets the same settings, so those workspaces would collide on tags and release branches. The example now uses literal keys and adds a caution.changelog,workspace,setup,completion, orupdate). It's now a table generated from the current--help.getsentry.github.io/craft, and its changelog-preview example usedpull_requestinstead ofpull_request_target.Existing URLs keep working.
/getting-started/,/configuration/, and/targets/github/are still there. The anchors that outside links point at also still resolve:configuration#auto-mode(printed by shipped Craft versions),configuration#ai-summaries,targets/github#release-workspaces, andgithub-actions#ai-summary-authentication. The semver warning insrc/utils/changelog.tsnow links tocraft.sentry.dev/changelogs/#categories.The new workspace page names one remaining gap: the changelog-preview workflow has no
workspaceinput yet.via @BYK.
--
View Junior Session [Sentry]