Skip to content

Point the observer comments at the doc's current name - #227

Closed
monthop-gmail wants to merge 1 commit into
cloudflare:mainfrom
monthop-gmail:fix-observers-doc-reference
Closed

Point the observer comments at the doc's current name#227
monthop-gmail wants to merge 1 commit into
cloudflare:mainfrom
monthop-gmail:fix-observers-doc-reference

Conversation

@monthop-gmail

@monthop-gmail monthop-gmail commented Aug 16, 2026

Copy link
Copy Markdown

What does this change?

Four comments in overseer.ts cite observers-implementation-plan.md, but the file is checked in as docs/observers.md — so following the reference finds nothing. I hit this while reading ensureObserver() and went looking for a file that isn't there.

Retargeted all four, matching how blueprint-archive.ts already cites docs/blueprints.md:

line now cites
397 docs/observers.md §3
2761 docs/observers.md §5 Step 5
6046 docs/observers.md §5 Step 6
6092 docs/observers.md §5 Step 3

Why is this obviously correct and trivially verifiable?

The patch is four comment lines; no code changes, so behaviour cannot move.

Both halves are checkable from the tree alone:

  • docs/observers.md exists and observers-implementation-plan.md does not.
  • Every cited section still exists under the new name — ## 3. Concepts & terminology, ### Step 3, ### Step 5, ### Step 6 — so each reference resolves to the passage it was always pointing at.

Checklist

  • This is a small, concrete change; it is not a feature, refactor, or low-value cleanup.
  • I understand that maintainers decide whether the change is obviously correct and trivially verifiable.
  • I have read and followed the contribution guidelines.

🤖 Generated with Claude Code

Four comments in overseer.ts cite observers-implementation-plan.md, but that
file is checked in as docs/observers.md, so following the reference finds
nothing. Retarget them, matching how blueprint-archive.ts cites docs/blueprints.md.

Every cited section still exists under the new name: §3 "Concepts &
terminology", and §5 "Step 3", "Step 5" and "Step 6".

Comments only; no code changes.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown


Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.


I have read the CLA Document and I hereby sign the CLA


You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot.

@github-actions

Copy link
Copy Markdown

Thank you for taking the time to contribute. This pull request was automatically closed because:

  • The "small, concrete change" confirmation is not checked.
  • The "maintainer assessment" confirmation is not checked.
  • The "contribution guidelines" confirmation is not checked.

Please update the pull request to meet these automatic checks, then reopen it. Passing these checks does not guarantee acceptance; maintainers still determine whether a change is obviously correct and trivially verifiable.

If an exception is appropriate, a maintainer can apply the policy/override label before reopening the pull request. See the contribution guidelines for details.

@github-actions github-actions Bot added the kernel Changes to the Workshop kernel label Aug 16, 2026
@github-actions github-actions Bot closed this Aug 16, 2026
@monthop-gmail

Copy link
Copy Markdown
Author

Superseded by #228 — I filed this one without the pull request template, so the policy checklist was missing. Sorry for the noise.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kernel Changes to the Workshop kernel

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant