refactor: consume docusaurus and md - #440
Merged
Merged
Conversation
osapi is the only repository with a Docusaurus site, so it takes both modules: docusaurus owns docs/ entirely -- build, serve, deploy and format -- and md formats every markdown file outside it. The site holds .mdx and component syntax mdformat cannot parse, which is why prettier keeps it. md_site_dir defaults to docs/, so the exclusion needs no override here. Also drops the docker module, which nothing invoked: images are published by goreleaser. Verified both formatters pass at once, so neither touches the other space. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Docs Lint ran two unrelated checks, so a red check did not say which formatter objected and neither could be re-run alone. Docusaurus Lint checks the site with prettier and provisions bun. Markdown Lint checks everything outside it with mdformat and provisions uv. Each installs only what it needs. Applies specify-workflow-naming task 2.6. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Renaming only the lint left Docusaurus Lint beside Docs Build and Deploy to GitHub Pages -- three names for one subject. The deploy name also described the hosting service, which can change without the workflow changing purpose. Applies specify-workflow-naming task 2.7. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## main #440 +/- ##
=======================================
Coverage 99.94% 99.94%
=======================================
Files 484 484
Lines 24935 24935
=======================================
Hits 24921 24921
Misses 14 14 Continue to review full report in Codecov by Harness.
🚀 New features to boost your workflow:
|
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.
osapi is the only repository with a Docusaurus site, so it is the only one that
takes both modules.
docusaurusdocs/entirely — build, serve, deploy, and formatmdThe site holds
.mdxfiles and component syntax that mdformat cannot parse,which is why prettier keeps it.
md_site_dirdefaults todocs/, so theexclusion needs no override here.
Verified they do not overlap
Both checks pass at the same time:
ui/docs/is correctly formatted bymd— it is not the site.Also
dockermodule. Nothing invoked it; images are published bygoreleaser, and its
dockerfiledefault named a file this repository does nothave. Per specs#50.
docs-build,docs-deploy, anddocs-lintworkflows renamed to the newrecipes;
docs-lintnow checks both formatters and provisions uv.development.mddescribedjust docs::*and said Prettier enforces the wraplimit everywhere. It now names which formatter owns which path.
Applies
converge-justfile-consumptiontasks 2.5 and 1.4.🤖 Generated with Claude Code