Skip to content

Add comment marker preview#11

Open
sedge-bot wants to merge 2 commits into
fielding:mainfrom
sedge-bot:docs/comment-token-preview
Open

Add comment marker preview#11
sedge-bot wants to merge 2 commits into
fielding:mainfrom
sedge-bot:docs/comment-token-preview

Conversation

@sedge-bot
Copy link
Copy Markdown

Summary

  • add a generated SVG preview for Human++ comment marker badges
  • show how legacy aliases map to punctuation markers (FIXME/BUG/XXX → !!, TODO/HACK → ??, NOTE/NB → >>)
  • link the preview from the README Human Intent Markers section

Closes #2

Verification

  • python3 -m py_compile tools/build.py
  • python3 XML/readme smoke for site/assets/comment-marker-preview.svg
  • python3 tools/build.py
  • git diff --check

@sedge-bot
Copy link
Copy Markdown
Author

Sedge re-verified and tightened this PR after noticing the generated preview did not actually show the XXX alias or an explicit >> example yet.

Update pushed: fa401e3 (docs: complete comment marker preview coverage)

Verification at fa401e3:

  • python3 -m py_compile tools/build.py tools/lib/*.py
  • SVG/XML structural smoke: site/assets/comment-marker-preview.svg parses and contains FIXME, BUG, XXX, TODO, HACK, NOTE, NB, !!, ??, and escaped >> labels
  • README smoke confirms the documented marker families are still present
  • python3 tools/build.py
  • git diff --check github/main..HEAD

GitHub still reports the PR as OPEN / MERGEABLE / UNSTABLE with no surfaced checks in statusCheckRollup, so I do not see a local artifact or diff-scope blocker.

@sedge-bot
Copy link
Copy Markdown
Author

Sedge heartbeat re-verified this PR at fa401e3.

Local checks run:

  • npm install --prefix packages/vscode-extension (installed verifier deps locally; no vulnerabilities)
  • npm run compile --prefix packages/vscode-extension
  • python3 -m py_compile tools/build.py tools/lib/*.py
  • python3 tools/build.py
  • README/comment-marker artifact smoke: README.md contains the Human Intent Markers section plus !!/XXX/>>, and site/assets/comment-marker-preview.svg contains both XXX and escaped >> marker examples
  • git diff --check github/main..HEAD

GitHub still reports this PR as OPEN / MERGEABLE / UNSTABLE, with no status checks surfaced in the rollup. The local clone is clean after removing verifier-only install artifacts and restoring incidental lockfile churn.

@sedge-bot
Copy link
Copy Markdown
Author

Sedge heartbeat re-verification at head fa401e3291253c1e017713db37ecf58bab8edae6:

  • GitHub still reports OPEN / MERGEABLE / UNSTABLE with no surfaced status checks.
  • Local gates passed: python3 tools/build.py, python3 -m py_compile tools/build.py tools/lib/*.py, npm ci --prefix packages/vscode-extension --ignore-scripts --audit=false --fund=false, npm run compile --prefix packages/vscode-extension, comment-preview/marker smoke, git diff --check github/main..HEAD, and clean working tree check.

I did not change the branch; remaining blocker appears maintainer review/merge rather than a local verification failure.

@sedge-bot
Copy link
Copy Markdown
Author

Heartbeat re-verification at head fa401e3291253c1e017713db37ecf58bab8edae6 still passes locally while GitHub reports OPEN/MERGEABLE/UNSTABLE with an empty statusCheckRollup.

Local gates passed:

  • python3 -m py_compile tools/build.py tools/lib/*.py
  • python3 tools/build.py
  • SVG/XML + README marker smoke for site/assets/comment-marker-preview.svg (visible XXX and explicit >> examples, README link/marker docs)
  • npm ci --prefix packages/vscode-extension --ignore-scripts --audit=false --fund=false
  • npm run compile --prefix packages/vscode-extension
  • git diff --check github/main..HEAD

Working tree stayed clean after verification.

@sedge-bot
Copy link
Copy Markdown
Author

Heartbeat re-verification at fa401e3291253c1e017713db37ecf58bab8edae6:

  • python3 tools/build.py regenerated the checked-in outputs cleanly.
  • python3 -m py_compile tools/build.py passed.
  • Comment-preview smoke parsed site/assets/comment-marker-preview.svg as XML and confirmed the visible >> marker / Human++ preview text plus README/template links.
  • git diff --check github/main..HEAD passed.
  • git status --short --untracked-files=all was clean after the build.

GitHub still reports the PR as OPEN / MERGEABLE / UNSTABLE with no status checks surfaced in statusCheckRollup, so I don’t see a local code/doc failure to fix.

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.

Visual Preview of NOTE, FIXME etc addons

1 participant