docs: rename to Harmon DevKit, fix doc inconsistencies, add template docs#2
Merged
Merged
Conversation
…READMEs - Rename all harmon-boilerplates references to harmon-devkit (README, package.json, Taskfile/Brewfile/requirements headers, CONTRIBUTING, CHECKLIST, copier answers) - Fix README badges: point at harmon-devkit, correct build.yml -> build.yaml, drop the retired Snyk badge service badge - Remove broken README link to gitignored todo.md and the stale .ansible-lint-ignore reference; strip utm tracking params - Add a template index and repository structure tables to the README - Add per-directory READMEs for templates/ and each category, including required .env setup for the n8n stack - Update CLAUDE.md to match the post-reorg layout (templates/, scripts/, ai/ instead of boilerplates/) - Fix CHECKLIST path to the shell script template - package.json license field: use SPDX "MIT" (matches LICENSE) - markdownlint: disable MD013 line-length (prose/table-heavy docs) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
README and CLAUDE.md document 'task bootstrap'; the task was named 'boostrap' so the documented command errored. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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
1 participant
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.
Summary
Documentation/consistency pass following the repo rename and folder reorg:
harmon-boilerplates/ "Harmon Boilerplates" references updated toharmon-devkit/ "Harmon DevKit" (README, package.json, Taskfile/Brewfile/requirements headers, CONTRIBUTING, CHECKLIST)..copier-answers.ymlis intentionally left untouched (it records the original copier answers).harmon-devkit(andbuild.yml→build.yamlso the Build badge resolves); removed the retired Snyk badge; removed the broken link to gitignoredtodo.md; fixed.ansible-lint-ignore→.ansible-lint; added a Repository Structure table and a Template Index table; replaced the TODO usage section with actual copy-and-adapt guidance; stripped utm tracking params from linkstemplates/,scripts/,ai/— the old text described a nonexistentboilerplates/tree with categories that don't exist)templates/,templates/docker/(+genericStack/,n8n-compose/),scriptTemplates/,serverlessFunctionTemplates/,webTemplates/. The n8n README documents the required-but-gitignored.env(a fresh clone can't start the stack without it)docs/CHECKLIST.mdpointed at a nonexistentdev/templates/...path; package.jsonlicensenow SPDX"MIT"(matches LICENSE); markdownlint MD013 (80-char lines) disabled since every doc in the repo exceeds itboostrap→bootstrap, so the command documented in README/CLAUDE.md actually exists (separate commit — easy to drop if you'd rather hold it)Notes
detect-private-keywas discussed but is already enabled in.pre-commit-config.yaml, so no change was needed for it.SKIP=ansible-lint: the pinned ansible-lint v6.22.2 hook crashes on Python 3.14 (ModuleNotFoundError: ansible.parsing.yaml.constructor) — pre-existing breakage, parked with the rest of the tooling fixes.package-lock.json, TODO npm scripts) are intentionally not addressed here per scope; expect the existing red checks to stay red.🤖 Generated with Claude Code