Skip to content

Create the_case_for_an_ai_header.mdx#287

Merged
dwjohnston merged 5 commits into
masterfrom
the-case-for-an-ai-header
Jul 1, 2026
Merged

Create the_case_for_an_ai_header.mdx#287
dwjohnston merged 5 commits into
masterfrom
the-case-for-an-ai-header

Conversation

@dwjohnston

Copy link
Copy Markdown
Owner

No description provided.

@dwjohnston

Copy link
Copy Markdown
Owner Author

@claude Assess for typos and propose a commit to fix please

@claude

claude Bot commented Jul 1, 2026

Copy link
Copy Markdown

Claude finished @dwjohnston's task in 50s —— View job


Claude finished the typo review

Todo list:

  • Read src/routes/posts/the_case_for_an_ai_header.mdx and identify typos
  • Fix identified typos
  • Commit and push the fix to this PR branch
  • Summarize changes

Typos fixed

Line (before) Issue Fix
"This is simple enough prompt that is hard to get wrong." missing article, awkward grammar "This is a simple enough prompt that it's hard to get wrong."
"...kind of though." wrong word "...kind of thought."
"...configured our AI to be commiting, and it has the 'Co-Authored-By:` note..." misspelling ("commiting"), mismatched quote marks (opens with ', closes with `) "...configured our AI to be committing, and it has the `Co-Authored-By:` note..." (also fixed "understand where the code from" → "understand where the code came from")
"...supervised the AI in creating tests cases..." pluralization typo "...supervised the AI in creating test cases..."

Pushed as commit d987e34 directly to this PR's branch (the-case-for-an-ai-header).

Note: I didn't touch the nested Markdown/TypeScript code-fence structure (lines 16–39) since that's a formatting choice rather than a typo, and it wasn't in scope for this request.

Co-authored-by: David Johnston <dwjohnston@users.noreply.github.com>


This is simple enough prompt that is hard to get wrong.
This is a simple enough prompt that it's hard to get wrong.

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@claude huh?

I'm sure

"This is a simple enough prompt that is hard to get wrong." is fine

@claude claude Bot Jul 1, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Claude finished @dwjohnston's task in 1m 15s —— View job


Todo

  • Read the trigger comment and current file state
  • Update line 42 wording per feedback
  • Commit and push
  • Summarize

Response

Fair pushback — you're right. Looking at it again:

  • Original: "This is simple enough prompt that is hard to get wrong." — missing the article "a" (a genuine typo).
  • My earlier "fix": "This is a simple enough prompt that it's hard to get wrong." — the "it's" swap wasn't needed; it was an unnecessary rewrite, not a typo fix.
  • Your version: "This is a simple enough prompt that is hard to get wrong." — grammatically correct as-is (the "that" clause modifies "prompt" directly), and just fixes the missing article.

I've reverted the wording to your version and pushed it as commit aadf79f directly to this PR's branch.

github-actions Bot and others added 2 commits July 1, 2026 04:01
Co-authored-by: David Johnston <dwjohnston@users.noreply.github.com>

When creating a new file add the following header to the top of it

\`\`\`typescript

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@claude this isn't playing very nicely - how am I meant to put these triple back ticks into a code block?

@claude claude Bot Jul 1, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Claude finished @dwjohnston's task in 1m 2s —— View job


Todo

  • Read src/routes/posts/the_case_for_an_ai_header.mdx to see the nested code-fence issue
  • Figure out how to properly escape/nest triple backticks in MDX
  • Implement the fix and push
  • Summarize

The issue

The old markup tried to nest a code block by escaping the inner backticks with backslashes:

```md
...
\`\`\`typescript
...
\`\`\`
...

That doesn't work here — MDX (via `@mdx-js/mdx` v3 / remark) follows CommonMark, and **backslash escapes are not processed inside fenced code blocks**. So `\`\`\`` is rendered literally as `\`\`\`` rather than becoming a real triple-backtick fence.

### The fix

The correct CommonMark way to nest a code block inside another is to make the **outer** fence *longer* than the inner one. I changed the outer fence from three backticks to four, and left the inner `typescript` fence as plain triple backticks:

````md
````md
## Agent Instructions
...
```typescript
...

...

This way the parser only closes the outer block when it hits a matching (4-backtick) fence, and the inner triple-backtick fence renders as a normal nested code block.

Pushed as commit e9015d8 directly to this PR's branch (the-case-for-an-ai-header).

Co-authored-by: David Johnston <dwjohnston@users.noreply.github.com>
@dwjohnston dwjohnston merged commit 45d1b3c into master Jul 1, 2026
6 of 7 checks passed
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