Add generating-coverage-reports docs page and .svx → .md export pipeline#5
Merged
Merged
Conversation
Implements Plan B of the consumer-generated-reports migration: - New docs section "Generating coverage reports" (usage group): per-language report commands, format auto-detection incl. Go's native profile, probe order for default paths, fail-vs-skip threshold rule, Cobertura quirks - scripts/export-docs.ts renders configured .svx files into GitHub markdown for the coverage-tracker repo: docs/generating-coverage-reports.md and docs/INSTALLATION.md (composed from the quick-start/installation/usage sections) — this repo is now the origin of truth for both - .github/workflows/export-docs.yml opens/updates a docs-sync PR against CoverageTracker/coverage-tracker on pushes to main touching .svx sources - Installation .svx sections enriched with downstream-only detail (webhook secret generation, CF_Authorization explanation, webhook-500 troubleshooting, resync example) and corrected wrangler.jsonc → .json - remark-tables plugin styles GFM pipe tables with the existing .deftable look; cross-links added between the installation guide and the new page - README documents the pipeline and COVERAGE_TRACKER_SYNC_TOKEN PAT setup Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Deploying coveragetracker-dev with
|
| Latest commit: |
edf3290
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://6b3f2919.coveragetracker-dev.pages.dev |
| Branch Preview URL: | https://feat-consumer-generated-repo.coveragetracker-dev.pages.dev |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Implements Plan B of the consumer-generated-reports migration plan (
docs/plans/consumer-generated-reports-migration-plan-v3.md).New docs page
src/lib/docs-content/12-generating-coverage-reports.svx— "Generating coverage reports" in the usage group (existing taxonomy; no newguidesgroup needed):max-complexity/max-duplicationthreshold makes the report mandatorycoverage-path(dynamic output paths)Later
.svxfiles renumbered (12–15 → 13–16) to slot the page after "Ingest from CI".Docs export pipeline (Phase 2a)
This repo is now the origin of truth for shared docs:
scripts/export-docs.tsrenders configured.svxfiles into GitHub markdown:docs/generating-coverage-reports.mdanddocs/INSTALLATION.md(composed from the quick-start/installation/usage sections) in the coverage-tracker repo<!-- site-only -->blocks are stripped; single-source targets get headings promoted one level.github/workflows/export-docs.ymlopens/updates a PR on the fixeddocs-syncbranch on pushes tomaintouching.svxsources; skips cleanly on no diffCOVERAGE_TRACKER_SYNC_TOKENfine-grained PAT setupCOVERAGE_TRACKER_SYNC_TOKENActions secret (steps in README), or the workflow fails at checkout.Installation content enrichment
Downstream-only detail was verified against the coverage-tracker code and ported into the
.svxsources so the generatedINSTALLATION.mdloses nothing actionable: webhook-secret generation command,CF_Authorizationsession-cookie explanation, webhook-500 troubleshooting (dedup clear + redeliver), resync curl example. Also fixeswrangler.jsonc→wrangler.json(the repo ships.json).Cross-linking (Phase 3)
Absolute URLs in both directions so links work on the site and on GitHub: verify/ingest sections →
coveragetracker.dev/docs#generating-coverage-reports; the new page → the GitHubINSTALLATION.md.Supporting changes
remark-tables.jstags GFM pipe tables with the existing.deftablestylingscripts/export-docs.test.ts) + remark-tables tests; vitest include widened toscripts/Verification
svelte-checkclean; production build prerenders the new section with styled tables and sidebar entryunchangedon re-run); generatedINSTALLATION.mdreviewed against the current downstream guide🤖 Generated with Claude Code