Skip to content

chore(template): conform to the DeesseJS template standard v1 - #13

Open
martyy-code wants to merge 3 commits into
mainfrom
chore/template-standard-v1
Open

martyy-code wants to merge 3 commits into
mainfrom
chore/template-standard-v1

Conversation

@martyy-code

@martyy-code martyy-code commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

What this pull request does

Applies the first tranche of the DeesseJS template standard, version 1.4, to documentation-template. The standard lives in the parent template, in templates/standard/template-standard-v1.md.

The manifest

deesse-template.json is added at the root of the repository. It is the machine readable contract of the template. It declares the technical fields owned by the Head of Templates, and the product fields owned by the Chief Product Officer.

Field Value
name documentation-template
slug docs-starter
title Docs Starter
type template:starter
license MIT
requires.node >=22
requires.packageManager pnpm@11.0.0
product.layer open-community
product.category docs
product.labels fumadocs, mdx, nextjs, llms

The manifest validates against the schema published by the parent template, at templates/schema/template-v2.json in the deessejs repository. The validation runs on every pull request and on every push to main, in the manifest.yml workflow, with a pinned validator. The command is npx --yes ajv-cli@5.0.0 validate -s template-v2.json -d deesse-template.json, and it passes on this file.

The rules applied

Rule Change
Rule 4 The root package name is the repository name
Rule 9 actions/checkout and actions/setup-node move from version 4 to version 5 in every workflow
Rule 15 .github/dependabot.yml is present, with a weekly schedule, a pull request limit and a group for the shared dependencies
Rule 16 The major update group is quarantined, the major bumps stay manual until the Next.js major migration lands
Rule 23 .claude/settings.local.json and .claude/worktrees/ are removed from the index and added to .gitignore
Rule 25 The manifest is Prettier clean
Rule 25 bis The manifest is validated in CI against the published schema, in the manifest.yml workflow, with a pinned validator, reading the schema from the parent template
Rule 26 The manifest excludes the machine specific paths and keeps the portable agent configuration
Rule 27 The manifest declares the licence that is actually shipped

The files in this pull request

Action Path
Removed .claude/settings.local.json
Added .github/dependabot.yml
Added .github/workflows/manifest.yml
Modified .gitignore
Added deesse-template.json
Modified package.json

What this pull request does not do

It does not merge, it does not publish a release, it does not change the organisation settings, it does not change the is_template flag, it does not archive or delete anything, and it does not change the branch protection. The pull request is open for review by the Head of Engineering and by the Head of Templates.

Known gaps

These are recorded in the conformance matrix with an owner and a target date. They are the second tranche, and they are not in this pull request.

  1. The workflow files are named build.yaml, lint.yaml and types.yaml instead of the ci.yml and release.yml pair. The consolidation lands in the next pull request.
  2. The root script contract is incomplete. format, format:check, type-check, test, test:coverage and setup are missing at the root, and the type check script is named types:check.
  3. .github/CODEOWNERS and .github/PULL_REQUEST_TEMPLATE.md are missing. The governance file set is completed in the next pull request.
  4. The is_template flag is still false.
  5. No CI job runs a format check. The lint job runs the linter only, so a formatting drift, including in the manifest, is caught by review only. The format:check script and the lint job step land in the next tranche.

The standard

The full standard, version 1.4, is in the parent template, in templates/standard/template-standard-v1.md, and the schema is in templates/schema/template-v2.json.

🤖 Generated with Claude Code

Co-Authored-By: Claude Code <noreply@anthropic.com>
@changeset-bot

changeset-bot Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 36aa647

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

martyy-code and others added 2 commits October 21, 2026 12:49
…hema

Rule 25 bis of the template standard. The workflow fetches the schema from the
parent template and validates deesse-template.json with a pinned validator, so a
manifest that drifts fails the pull request instead of the catalogue.

Co-Authored-By: Claude Code <noreply@anthropic.com>
Two fixes on the manifest validation workflow.

The schema is fetched from the main branch of the parent template first and
falls back on the branch that carries the standard, so the check works
before the standard pull request lands.

The automatic package manager cache of the setup node action is off. The
workflow installs nothing, and the action was running the package manager
to find its store path.

Co-Authored-By: Claude Code <noreply@anthropic.com>
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