Skip to content

docs: badge polish + post-release housekeeping#105

Merged
Data-Wise merged 2 commits into
mainfrom
dev
May 13, 2026
Merged

docs: badge polish + post-release housekeeping#105
Data-Wise merged 2 commits into
mainfrom
dev

Conversation

@Data-Wise
Copy link
Copy Markdown
Owner

Summary

Post-v2.18.0 doc polish — propagates two follow-up commits from dev to main. No code changes, no version bump.

Commits:

  • ebc90f0.STATUS updated for the v2.18.0 ship (status header, Session 91 summary, v2.18.1 maintenance suggestions). docs/index.md What's New section refreshed (the macro-rendered header advanced to v2.18.0 but the hand-maintained body still described v2.16.0 Canvas QTI — now describes Rich Exam LaTeX).
  • 58e0c2b — Badge audit fixes: badges moved above-the-fold in docs/index.md (was ~20 lines from top after the TL;DR block, now ~5 lines); 2 new CI status badges (Scholar CI + Docs Deploy) added to both surfaces; test count formatting harmonized (3400 → 3,400 in README badge to match the comma-formatted prose throughout docs); scripts/version-sync.js updated to preserve the comma on future syncs via formatCount().

What's NOT in this PR

  • No code changes (no version bump, no new features, no bug fixes to feature code)
  • No new dependencies
  • Pre-existing tech debt (ESLint warnings, npm audit vulnerabilities) is documented in .STATUS Future Suggestions and queued for v2.18.1 — out of scope here.

Test plan

  • All substantive CI checks pass (Scholar CI, Validate Plugin Structure, Validate JSON Schemas, Spell Check, Lint Markdown, Doc Structure, Dependency Audit, Run Test Suite)
  • Link checker is expected to flake on status-0 GitHub URLs (same pattern as PR Release: v2.18.0 — Rich Exam LaTeX Format #104); merge with --admin if it does and substantive checks are all green
  • After merge: confirm the new CI badges resolve on the live docs site (https://Data-Wise.github.io/scholar/) and on the GitHub repo README
  • After merge: verify badges render above-the-fold on docs/index.md

🤖 Generated with Claude Code

Test User and others added 2 commits May 12, 2026 22:26
…hat's New

.STATUS (Session 91 + future suggestions):
  - Status header: pre-release → post-release ("RELEASED 2026-05-13")
  - Next milestone: v2.18.1 maintenance window (3 high-confidence quick wins)
  - Future Suggestions block (NEW):
      v2.18.1 quick wins: npm audit fix, ESLint cleanup, \printanswers
        short-answer wrapping
      Doc consolidation: single-source teaching_style.exam, remove
        render_macros:false from FAQ, README → discovery-engine sync
      v2.19.0 candidates: custom tutorial generator, hub flag-filter
        UX, dedicated arxiv tutorial
  - Session 91 summary: release pipeline, +8 parallel tutorials,
    ADHD 75→83, help-doc audit, full site sync, hub.md drift fix
  - Release History row updated with +8 tutorials / ADHD score / date

docs/index.md What's New section:
  - Replaced stale v2.16.0 Canvas QTI content with v2.18.0 Rich Exam
    LaTeX content (the header was rendering "v2.18.0" but the body
    described Canvas QTI — a version-vs-content drift introduced when
    macros took over the header but the prose was never updated)
  - Previous Releases: backfilled v2.17.0 + v2.16.0 (previously stopped
    at v2.10.0)
  - Release notes link list: added v2.17.0 + v2.18.0
  - Stats table: added Tutorials row (7 → 38, +31, ~5x)

Verified all version surfaces in sync (no drift):
  package.json, plugin.json, mkdocs.yml → 2.18.0
  README version badge → 2.18.0
  README test badge → 3400
  mkdocs.yml test_count → 3,400
  tests/README total → 3,400
  version-sync.js dry-run: 0 changes / 22 skips / 0 errors

Lint + link-check clean.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…comma

Three badge-related fixes from a structural audit of docs/index.md and README.md:

1. **Badge placement in docs/index.md** — moved 3 badges from line 19-21
   (after a 13-line TL;DR + intro paragraph) to lines 5-9 (right after the
   tagline). README pattern matches GitHub convention; docs/index.md was
   pushing badges below-the-fold for ADHD users who scan-read the landing.

2. **Added 2 CI status badges** to both surfaces:
   - Scholar CI (.github/workflows/ci.yml on main)
   - Docs Deploy (.github/workflows/docs.yml on main)
   Both link to the filtered workflow run history. Per CLAUDE.md memory,
   the URLs use ?branch=main for release-validation compatibility.

3. **Harmonized test count formatting (3400 → 3,400)** — README badge
   previously rendered "3400 passing" while docs/index.md rendered
   "3,400 passing" (the comma comes from mkdocs.yml extra.scholar.
   test_count which is used in 10+ prose contexts where the comma
   improves readability). Updated README badge to use the comma, and
   updated scripts/version-sync.js to emit formatCount(testCount)
   for the Badge-test-count pattern so future syncs preserve the comma.

Verification:
- Lint clean (markdownlint)
- Link-check clean
- version-sync.js dry-run: 0 changes, 28 skips (correctly idempotent)
- All 5 version surfaces still in sync at v2.18.0 / 3,400 tests

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@Data-Wise Data-Wise merged commit 8dd9767 into main May 13, 2026
14 of 16 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