diff --git a/.claude/skills/README.md b/.claude/skills/README.md index da43dbb0..29a5ff0d 100644 --- a/.claude/skills/README.md +++ b/.claude/skills/README.md @@ -17,4 +17,4 @@ These skills are opinionated about safety and never: run a package manager or `n Dependency installation and `npm run init` require consent. The init skill uses the declared dependencies; Composer's install hook already runs npm. Sibling dependency checkouts are maintainer work. After file changes, refresh the local graph with `graphify update .`. -Cleanup removes the Copilot-specific files under `.github` (`copilot-instructions.md`, `prompts/`, `instructions/`) and the starter's own repository files (`.gitattributes`, `CODEOWNERS`, the bug and feature issue forms and their `config.yml`, `labels.yml`, `SECURITY.md`); the PR template, `dependabot.yml`, and workflows stay. `sync-ai` restores only generated framework instructions. The Claude skills remain. Review these removals before personalizing a clone. +Cleanup removes the Copilot-specific files under `.github` (`copilot-instructions.md`, `prompts/`, `instructions/`) and the starter's own repository files (`.gitattributes`, `CODEOWNERS`, the bug and feature issue forms and their `config.yml`, `labels.yml`, `SECURITY.md`, and the documentation and release workflows); the PR template, `dependabot.yml`, and the other workflows stay. `sync-ai` restores only generated framework instructions. The Claude skills remain. Review these removals before personalizing a clone. diff --git a/.gitattributes b/.gitattributes index 7d7c4599..219d26ed 100644 --- a/.gitattributes +++ b/.gitattributes @@ -9,6 +9,7 @@ /.github/ISSUE_TEMPLATE/config.yml export-ignore /.github/ISSUE_TEMPLATE/feature.yml export-ignore /.github/labels.yml export-ignore +/.github/workflows/documentation.yml export-ignore /SECURITY.md export-ignore /.github/release-starter export-ignore /.github/workflows/release-starter.yml export-ignore diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 2c7d02cb..646b2393 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -28,6 +28,8 @@ concurrency: jobs: build: + # Starter-only: init removes this file from generated themes. The guard keeps forks from building the site. + if: github.repository == 'rtCamp/theme-elementary' name: Build documentation runs-on: ubuntu-latest timeout-minutes: 15 diff --git a/README.md b/README.md index 241801ff..c80485de 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ This theme ships AI-assisted setup and feature scaffolding, kept in step across - **Claude Code:** retained skills in [`.claude/skills/`](.claude/skills/) — `/init`, `/scaffold`, and `/setup`. - **GitHub Copilot:** `/init` and `/scaffold` prompts are available while setting up this source repository. - - Initialization removes the Copilot-specific files under `.github` (`copilot-instructions.md`, `prompts/`, `instructions/`) and the starter's own repository files, such as `CODEOWNERS`, the issue forms and `SECURITY.md`; the PR template and workflows stay. + - Initialization removes the Copilot-specific files under `.github` (`copilot-instructions.md`, `prompts/`, `instructions/`) and the starter's own repository files, such as `CODEOWNERS`, the issue forms, `SECURITY.md` and the documentation and release workflows; the PR template and the other workflows stay. - A committed knowledge graph in [`graphify-out/`](graphify-out/) lets AI assistants query the codebase's structure instead of reading it all; see [docs/internal/knowledge-graph.md](docs/internal/knowledge-graph.md) for how it's built and kept current. Shared conventions for all assistants live in [AGENTS.md](AGENTS.md). diff --git a/bin/scaffold.config.js b/bin/scaffold.config.js index 85f8ddd2..d852f8e2 100644 --- a/bin/scaffold.config.js +++ b/bin/scaffold.config.js @@ -17,8 +17,9 @@ const path = require('path'); // theme-elementary's own repository files, kept out of new projects. Cleanup also runs on // --reinit, "Re-run full setup" and --clean, and a project's own CODEOWNERS, -// SECURITY.md, .gitattributes or issue forms live at these same paths, so they -// are removed on first setup only: before init writes .wp-scaffold.json. +// SECURITY.md, .gitattributes, issue forms or docs workflow live at these same +// paths, so they are removed on first setup only: before init writes +// .wp-scaffold.json. // .gitattributes export-ignores the same paths; tests/js/starter-files.test.js // keeps the two lists in step. const STARTER_REPO_FILES = [ @@ -29,6 +30,7 @@ const STARTER_REPO_FILES = [ '.github/ISSUE_TEMPLATE/config.yml', '.github/ISSUE_TEMPLATE/feature.yml', '.github/labels.yml', + '.github/workflows/documentation.yml', 'SECURITY.md', ]; const firstSetup = !fs.existsSync( diff --git a/composer.json b/composer.json index 65b3e2dc..4baae160 100644 --- a/composer.json +++ b/composer.json @@ -1,6 +1,6 @@ { "name": "rtcamp/theme-elementary", - "description": "A starter theme that facilitates a quick head start for developing new block-based themes along with a bunch of developer-friendly features.", + "description": "Elementary Theme block theme, built on rtCamp theme-elementary.", "type": "wordpress-theme", "homepage": "https://rtcamp.com/", "license": "GPL-2.0-or-later", diff --git a/docs/initialization.md b/docs/initialization.md index 4c250288..85e1148a 100644 --- a/docs/initialization.md +++ b/docs/initialization.md @@ -60,7 +60,7 @@ npm run init -- --name="Acme Blog" --version=1.0.0 --yes --remove-examples | Optional features | HMR updates `.env.local`; Tailwind adds its entry/config and declarations. | | State | `.wp-scaffold.json` records identity and feature choices; do not hand-edit it. | | Autoload | Setup regenerates Composer's autoloader. | -| Cleanup | Before the wrapper's final sync, the Copilot-specific `.github` files (`copilot-instructions.md`, `prompts/`, `instructions/`) and `languages` (including the starter POT file) are removed, with the starter's own repository files: `.gitattributes`, `.github/CODEOWNERS`, the bug and feature issue forms and their `config.yml`, `.github/labels.yml`, `SECURITY.md`, and its release workflow, config and manifest (`.github/workflows/release-starter.yml`, `.github/release-starter/`). A `composer create-project` copy never contains those repository files. The other workflows, the PR template, and `dependabot.yml` stay untouched. | +| Cleanup | Before the wrapper's final sync, the Copilot-specific `.github` files (`copilot-instructions.md`, `prompts/`, `instructions/`) and `languages` (including the starter POT file) are removed, with the starter's own repository files: `.gitattributes`, `.github/CODEOWNERS`, the bug and feature issue forms and their `config.yml`, `.github/labels.yml`, `SECURITY.md`, its documentation site workflow (`.github/workflows/documentation.yml`), and its release workflow, config and manifest (`.github/workflows/release-starter.yml`, `.github/release-starter/`). A `composer create-project` copy never contains those repository files. The other workflows, the PR template, and `dependabot.yml` stay untouched. | | AI instructions | After a successful change, the wrapper runs `sync-ai`; in a standalone project with the framework installed, it refreshes the generated framework PHP instructions. It does not restore the removed prompts or theme-specific rules. | | Retained files | Theme source, `bin/`, Claude skills, documentation, and test infrastructure remain; files belonging to removed example sets do not. | diff --git a/docs/internal/maintenance.md b/docs/internal/maintenance.md index 4384cf73..11defc25 100644 --- a/docs/internal/maintenance.md +++ b/docs/internal/maintenance.md @@ -18,7 +18,7 @@ If an installation route or feature cannot be exercised, report the missing prer ### Cleanup checks -Check that the Copilot-specific `.github` files (`copilot-instructions.md`, `prompts/`, `instructions/`) and `languages` are removed, along with the starter's own repository files (`.gitattributes`, `.github/CODEOWNERS`, the bug and feature issue forms and their `config.yml`, `.github/labels.yml`, `SECURITY.md`) and its release workflow, config and manifest (`.github/workflows/release-starter.yml`, `.github/release-starter/`), while the other workflows and the PR template stay untouched. In a `composer create-project` copy, confirm those repository files were never there: `.gitattributes` export-ignores them, and its list must match `cleanup.targets` in `bin/scaffold.config.js`. Also confirm the init wrapper script is not removed by cleanup, and that `sync-ai` (see [initialization.md](../initialization.md#what-changes)) restores only generated framework instructions. Claude skills and documentation remain; Copilot prompts and theme-specific GitHub rules do not. Run POT generation separately to verify the language output can be recreated. +Check that the Copilot-specific `.github` files (`copilot-instructions.md`, `prompts/`, `instructions/`) and `languages` are removed, along with the starter's own repository files (`.gitattributes`, `.github/CODEOWNERS`, the bug and feature issue forms and their `config.yml`, `.github/labels.yml`, `SECURITY.md`, the documentation site workflow `.github/workflows/documentation.yml`) and its release workflow, config and manifest (`.github/workflows/release-starter.yml`, `.github/release-starter/`), while the other workflows and the PR template stay untouched. In a `composer create-project` copy, confirm those repository files were never there: `.gitattributes` export-ignores them, and its list must match `cleanup.targets` in `bin/scaffold.config.js`. Also confirm the init wrapper script is not removed by cleanup, and that `sync-ai` (see [initialization.md](../initialization.md#what-changes)) restores only generated framework instructions. Claude skills and documentation remain; Copilot prompts and theme-specific GitHub rules do not. Run POT generation separately to verify the language output can be recreated. Check references in retained documentation and AI instructions. Use upstream source links for optional examples or starter-only files that cleanup may remove. Do not silently change the cleanup contract as part of a documentation correction. @@ -71,7 +71,7 @@ When done, restore only the dependency source/constraint and local repository en ## Documentation publishing -Markdown under `docs/` is rendered by the [shared documentation workflow](https://github.com/rtCamp/action-docusaurus-build/blob/codex/documentation-workflow/README.md). The root Development and Contributing guides remain GitHub pages linked from the site. No Docusaurus dependencies or generated site files belong in this theme. +Markdown under `docs/` is rendered by the [shared documentation workflow](https://github.com/rtCamp/action-docusaurus-build/blob/codex/documentation-workflow/README.md). The root Development and Contributing guides remain GitHub pages linked from the site. No Docusaurus dependencies or generated site files belong in this theme. The workflow is starter-only: its build job runs only in `rtCamp/theme-elementary`, init removes the file on first setup, and `.gitattributes` export-ignores it, so generated themes never get it. The caller supplies the main sidebar order; Markdown needs no sidebar metadata. Advanced guides remain linked from the relevant task pages. Internal pages are reached through Contributing and are omitted from the main sidebar. diff --git a/package.json b/package.json index e9bd78dc..86049995 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "elementary-theme", "version": "2.0.1", - "description": "A starter theme that facilitates a quick head start for developing new block-based themes along with a bunch of developer-friendly features.", + "description": "Elementary Theme block theme, built on rtCamp theme-elementary.", "author": "rtCamp", "license": "GPL-2.0-or-later", "keywords": [ diff --git a/style.css b/style.css index 1f254d45..7d6337e7 100644 --- a/style.css +++ b/style.css @@ -3,7 +3,7 @@ * * Theme Name: Elementary Theme * Theme URI: https://rtcamp.com/ - * Description: A modern starter theme for developing Full Site Editing (FSE) block-based WordPress themes with comprehensive developer tools and best practices. + * Description: Elementary Theme block theme, built on rtCamp theme-elementary. * x-release-please-start-version * Version: 2.0.1 * x-release-please-end