Add rumdl Markdown linting #484
Conversation
✅ Deploy Preview for zero-to-nix ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughAdded Nix CI execution and an external link check to the GitHub workflow; introduced rumdl-based Markdown linting (config and ignore); updated flake inputs/outputs to an inputs-based pattern and added rumdl to devShell; replaced îles with Astro in README; removed or reformatted multiple MDX link references and added flake template examples in one start document. Changes
Sequence Diagram(s)sequenceDiagram
participant GH as GitHub Actions
participant Nix as Nix devShell
participant CI as Project CI script
participant Rumdl as rumdl linter
participant Lychee as Lychee link checker
GH->>Nix: nix develop --command ci
activate Nix
Nix->>CI: run ci tasks (incl. lint-markdown)
activate CI
CI->>Rumdl: run `rumdl check` (uses .rumdl.toml)
activate Rumdl
Rumdl-->>CI: lint results
deactivate Rumdl
CI-->>Nix: complete
deactivate CI
deactivate Nix
GH->>Lychee: run lycheeverse/lychee-action@v2 (cache, args, fail:false)
activate Lychee
Lychee-->>GH: link report (non-blocking)
deactivate Lychee
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (3)
🚧 Files skipped from review as they are similar to previous changes (3)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
src/content/plain/about.mdx (1)
13-14: Minor style suggestion: Consider "except" or "except for" instead of "with the exception of".The static analysis tool flagged a style opportunity on line 13. While this is minor, you may consider rephrasing for a more concise tone.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
flake.lockis excluded by!**/*.lock
📒 Files selected for processing (17)
.github/workflows/ci.yml(2 hunks).gitignore(1 hunks).rumdl.toml(1 hunks)README.md(2 hunks)flake.nix(5 hunks)package.json(1 hunks)src/content/concepts/caching.mdx(0 hunks)src/content/concepts/derivations.mdx(0 hunks)src/content/concepts/flakehub.mdx(0 hunks)src/content/concepts/flakes.mdx(0 hunks)src/content/concepts/incremental-builds.mdx(0 hunks)src/content/plain/about.mdx(1 hunks)src/content/start/1.install.mdx(0 hunks)src/content/start/2.nix-run.mdx(0 hunks)src/content/start/3.nix-develop.mdx(10 hunks)src/content/start/4.nix-build.mdx(9 hunks)src/content/start/5.nix-search.mdx(0 hunks)
💤 Files with no reviewable changes (8)
- src/content/concepts/incremental-builds.mdx
- src/content/start/5.nix-search.mdx
- src/content/concepts/flakehub.mdx
- src/content/start/2.nix-run.mdx
- src/content/concepts/caching.mdx
- src/content/concepts/flakes.mdx
- src/content/start/1.install.mdx
- src/content/concepts/derivations.mdx
🧰 Additional context used
🪛 LanguageTool
src/content/plain/about.mdx
[style] ~14-~14: Consider using “except” or “except for”
Context: ...official Nix documentation sources (with the exception of the [Wiki entry][wiki] for flakes). ##...
(WITH_THE_EXCEPTION_OF)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: test
🔇 Additional comments (10)
src/content/plain/about.mdx (1)
9-11: Indentation alignment looks good.The formatting changes properly align continuation lines within list items, which aligns with Markdown linting standards.
Also applies to: 13-14
src/content/start/3.nix-develop.mdx (1)
72-78: Appreciate the nested list formatting cleanup.
The adjusted indentation keeps the ordered list and nested bullets rendering cleanly while meeting rumdl’s expectations..gitignore (1)
20-21: Good call ignoring the rumdl cache.
Keeping.rumdl-cache/out of source control will prevent noisy diff churn from local lint runs.README.md (1)
76-76: Glad to see the stack description updated.
Calling out Astro reflects the current site generator and keeps the tech list accurate for contributors.src/content/start/4.nix-build.mdx (1)
152-207: The new template init snippets are helpful.
Spelling out the per-languagenix flake initcommands lowers the barrier for readers jumping into the examples..rumdl.toml (1)
1-33: Configuration looks balanced.
The rule allow-list mirrors our MDX conventions (shell hooks, tables, component markup) without muting broader lint coverage.flake.nix (1)
50-122: Nice addition wiring rumdl into the dev shell and CI.
Bundling the package plus a dedicatedlint-markdownscript makes the new check turnkey for both local and CI workflows.package.json (1)
12-12: Missing rumdl dependency in package.json.The new "mdlint" script references
rumdl, but it's not listed in devDependencies. If rumdl is intended to be available only through the Nix development environment (via flake.nix), this is fine, but ensure the script is documented or used only withinnix develop. Otherwise, add rumdl to devDependencies so npm can resolve it..github/workflows/ci.yml (2)
36-46: Lychee external link check configuration looks sound.The step is well-configured with caching, verbose output, and proper target directory. One minor note: the
GITHUB_TOKENenv on line 39 is redundant since it's already available from the job-level env on line 13, but this doesn't cause issues.
33-34: No issues found—markdown linting is properly integrated.The
cicommand in flake.nix correctly includes thelint-markdownstep, which invokesrumdl check. This fulfills the PR objective to add markdown linting to CI checks. When the workflow runsnix develop --command ci, it will execute the full pipeline including markdown linting.
Summary by CodeRabbit
New Features
Documentation
Chores