justin/ai-workflow-course
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

style(no-slop): de-em-dash the internal docs + config (repo now fully clean)

Browse Source 
- AGENTS.md (the standard-bearer), _TEMPLATE.md, handoff.md, tools/README.md:
  em-dashes removed by restructuring, banned words replaced; all policy/structure
  and decisions preserved.
- .gitea/.github sync-wiki workflows, .claude/gitea-ship.json, .gitignore: em-dashes
  in comments/log strings/notes removed; YAML/JSON still valid.

The entire tracked repo is now em-dash-free (the lone remaining `—` is inside a
regex character class in tools/build_wiki.py, intentional, matches old titles).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TfzV5QvtPDz8LJS3Pu5VLT
This commit is contained in:
Claude (agent)
2026-06-23 08:51:37 -04:00
parent 863435915c
commit 4f25e3a794
8 changed files with 70 additions and 69 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AGENTS.md
+14 -13
View File
@@ -1,15 +1,15 @@
# AGENTS.md — instructions for AI agents working in this repo
# AGENTS.md: instructions for AI agents working in this repo
> This is the committed AI instructions file for *The Workflow* course. It exists for two reasons:
> it actually configures the agents that help author the course, **and** it is a live worked example
> of [Module 5 — Commit the AI's Config, Not Just the Code](modules/05-commit-the-ai-config/). The
> of [Module 5: Commit the AI's Config, Not Just the Code](modules/05-commit-the-ai-config/). The
> filename is deliberately vendor-neutral: most agentic coding tools read a repo-level instructions
> file, and the principle outlives any one vendor's filename. If your tool looks for a different
> name, point it here.
## What this repo is
A course that teaches IT professionals the engineering toolchain *around* AI coding — version
A course that teaches IT professionals the engineering toolchain *around* AI coding: version
control, collaboration, CI/CD, and the tools that extend AI into real systems. The repo is both the
course content and a dogfooded example of the practices it teaches.
@@ -23,22 +23,22 @@ course content and a dogfooded example of the practices it teaches.
- **Model-agnostic in principle; Claude Code as the concrete example.** The concepts and workflow
never depend on one LLM or tool. Name the common agentic tools once, then use **Claude Code** as
the worked example in commands and labs — e.g. `claude --version # sub your own agent`. Keep the
the worked example in commands and labs, e.g. `claude --version # sub your own agent`. Keep the
*concepts* vendor-neutral; use a concrete tool so steps aren't abstract. Examples must survive a
model swap.
- **GitHub is the default, not the requirement.** Keep hosting content provider-neutral; name the
alternatives and the self-host track. Do not reintroduce a single specific forge as *the* answer.
- **The dependency chain is load-bearing.** A module may assume only what precedes it. Never
reference a tool before its introducing module. If you think something should move, **flag it** —
reference a tool before its introducing module. If you think something should move, **flag it**;
don't silently reorder.
- **Honesty about limits.** Where a tool or analogy breaks, say so. Don't sand off the caveats.
- **Don't pad.** This audience reads fast and trusts concrete over comprehensive. Lead with the
- **Don't pad.** This audience reads fast and trusts the concrete over the exhaustive. Lead with the
pain, show the command and the failure mode.
## What the course teaches about git (the reframe)
This is **not** a "memorize git commands" course. The reader should finish knowing git is
*critical*, understanding the *concepts* and the *basics*, and — above all — that they don't have to
*critical*, understanding the *concepts* and the *basics*, and, above all, that they don't have to
memorize commands because **the AI drives git for them**. The analogy: learn arithmetic by hand,
then use a calculator.
@@ -46,14 +46,14 @@ then use a calculator.
learner types git to build intuition. Keep that.
- **Module 4 is the pivot.** It puts the AI in the editor/CLI. From there on the learner **directs
the AI** to do the git work (commit, branch, merge, revert, decide what to commit) and **verifies**
the result — they don't type the commands by hand, and modules must not tell them to.
the result; they don't type the commands by hand, and modules must not tell them to.
- **Don't re-teach basics.** Once a concept is introduced, later modules build on it through the AI;
they don't re-explain how to create a branch, etc.
## Lesson vs. lab (keep them separate)
- The **lesson / Key-concepts** section is **theory**. To show a command, show it *with example
output* as illustration — never instruct the reader to *run* it there.
output* as illustration; never instruct the reader to *run* it there.
- **All hands-on execution lives in the lab.** The lesson must not duplicate commands the lab runs.
## Voice
@@ -63,8 +63,9 @@ No motivational filler. When in doubt, show the command and what goes wrong with
**No slop (hard rules).** Don't write like an AI.
- **No em-dash character (`—`) anywhere.** Use a semicolon, a period, a comma, or restructure the
sentence. This is absolute; self-check every edit by searching for `—` and removing each one.
- **No em-dash character anywhere.** Use a semicolon, a period, a comma, or restructure the
sentence. This is absolute; self-check every edit by searching for that character and removing
each one.
- **Banned words:** "prose" (say "writing"/"words"/"docs"), delve, leverage, utilize, foster,
bolster, underscore, unveil, streamline, robust, comprehensive, pivotal, seamless, significantly,
extremely, truly, unlock, "dive in".
@@ -86,7 +87,7 @@ No motivational filler. When in doubt, show the command and what goes wrong with
This repo is hosted on `git.jpaul.io`. Follow the same flow the course teaches:
- **Never commit directly to `main`.** Branch per module/change, open a PR, squash-merge. The PR is
the review gate (Module 10) even for solo work — it exists for traceability.
the review gate (Module 10) even for solo work; it exists for traceability.
- **Build in dependency-chain order.** Modules 1–2 are the locked exemplars; match their tone,
depth, and lab style.
- **Verify before publishing volatile claims.** Anything about pricing, versions, or tool behavior
@@ -95,7 +96,7 @@ This repo is hosted on `git.jpaul.io`. Follow the same flow the course teaches:
## Don't
- Duplicate or fork `the-workflow-syllabus.md` — edit it in place if structure changes.
- Duplicate or fork `the-workflow-syllabus.md`; edit it in place if structure changes.
- Reorder modules or break the dependency chain without flagging it.
- Pin to a specific LLM vendor or a specific tool's config filename.
- Write pricing/version claims from memory.