Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .claude/skills/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down
6 changes: 4 additions & 2 deletions bin/scaffold.config.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* Scaffold config for theme-elementary, consumed by bin/init.js and handed to
* the shared init engine in @rtcamp/wp-tooling.

Check warning on line 3 in bin/scaffold.config.js

View workflow job for this annotation

GitHub Actions / ci / Lint JS / ESLint

Unexpected inline JSDoc tag. Did you mean to use {@rtCamp}, \@rtCamp, or `@rtcamp`?
*
* Search tokens are embedded verbatim; safe because the engine never
* search-replaces files under bin/.
Expand All @@ -17,8 +17,9 @@

// 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 = [
Expand All @@ -29,6 +30,7 @@
'.github/ISSUE_TEMPLATE/config.yml',
'.github/ISSUE_TEMPLATE/feature.yml',
'.github/labels.yml',
'.github/workflows/documentation.yml',
'SECURITY.md',
];
const firstSetup = !fs.existsSync(
Expand Down
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
2 changes: 1 addition & 1 deletion docs/initialization.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. |

Expand Down
4 changes: 2 additions & 2 deletions docs/internal/maintenance.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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": [
Expand Down
2 changes: 1 addition & 1 deletion style.css
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading