Skip to content

docs: Restructure docs around Craft concepts instead of targets - #935

Merged
BYK merged 1 commit into
masterfrom
docs/restructure-information-architecture
Oct 27, 2026
Merged

BYK merged 1 commit into
masterfrom
docs/restructure-information-architecture

Conversation

@sentry-junior

@sentry-junior sentry-junior Bot commented Oct 27, 2026

Copy link
Copy Markdown
Contributor

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.md was a ~900-line catch-all, and getting-started.md mixed installation, CLI help dumps, versioning, dry-run, and project setup.

New sidebar

  • Start Here: Introduction, Installation (new, split out of Getting Started), and Quick Start (/getting-started/, rewritten as a setup-and-first-release walkthrough)
  • Guides: Release Workflow, Versioning, Changelogs, AI Changelog Summaries, Monorepos & Release Workspaces, GitHub Actions
  • Targets: unchanged pages. The overview is now grouped by category, and the GitHub target page only covers GitHub-specific behavior.
  • Reference: Configuration (a compact table of every .craft.yml key, plus a minVersion feature-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:

  • onlyIfPresent was listed as a per-target option, but only the registry target supports it.
  • GitHub Actions docs were missing the workspace, craft_version, llm, and llm_api_key inputs and the action-only changelog_file and issue_url outputs. They also claimed the action and the workflow have identical outputs, which isn't true.
  • The "Skipping Changelog Entries" section on the Actions page told people to put categories in .craft.yml. That schema ignores them; categories belong in .github/release.yml. I removed it and linked to the Changelogs page instead.
  • Getting Started said automatic version bumping starts at minVersion 2.19.0. The code gate is 2.21.0. It also used actions/upload-artifact@v2, which is retired.
  • The versioning policy table didn't explain the real default: auto when minVersion is 2.14.0 or later, manual otherwise.
  • The workspace example used a packages/* glob with one tagPrefix. 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.
  • The CLI usage block was stale (no changelog, workspace, setup, completion, or update). It's now a table generated from the current --help.
  • The README pointed at getsentry.github.io/craft, and its changelog-preview example used pull_request instead of pull_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, and github-actions#ai-summary-authentication. The semver warning in src/utils/changelog.ts now links to craft.sentry.dev/changelogs/#categories.

The new workspace page names one remaining gap: the changelog-preview workflow has no workspace input yet.

via @BYK.

--

View Junior Session [Sentry]

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>
@github-actions

github-actions Bot commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor
PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-10-27 18:41 UTC

@BYK
BYK merged commit dbab5a6 into master Oct 27, 2026
29 checks passed
@BYK
BYK deleted the docs/restructure-information-architecture branch October 27, 2026 18:41

This branch was successfully deployed

1 active deployment
false — 389a756b Deployed Oct 27, 2026 by sentry-junior[bot] via Build #3228
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant