Skip to content

Fix markdown formatting of guides according to linter#553

Merged
razvand merged 8 commits intounikraft:mainfrom
ericsandu:ericsandu/fix-guides-linter
May 3, 2026
Merged

Fix markdown formatting of guides according to linter#553
razvand merged 8 commits intounikraft:mainfrom
ericsandu:ericsandu/fix-guides-linter

Conversation

@ericsandu
Copy link
Copy Markdown
Contributor

This PR fixes some common recurring markdown formatting errors in the Unikraft guides, as pointed out by markdownlint.

The most common error was MD104 (One Sentence per Line). It seems that this error is also caued by abbreviations such as i.e. or e.g. and structures like .... Errors in such cases aren't taken into account.

Code blocks have been formatted appropriately, with text headers being given to the unlabeled ones and blank lines between the fences being introduced.

Heading order has also been fixed and duplicate header names have been renamed appropriately to fit their context.

Lists now all use 1. 1. 1. for their ordering and non descriptive labels have been given appropriate names.

advanced-porting.mdx contained some formatting errors too, but it's been left untouched as it will be replaced via this PR, where it's formatting issues are solved.

@ericsandu ericsandu marked this pull request as ready for review April 25, 2026 16:47
Copilot AI review requested due to automatic review settings April 25, 2026 16:47
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates several Unikraft guide MDX files to comply with markdownlint by improving Markdown formatting (code block fencing/language tags, heading structure, and minor wording tweaks) across the documentation guides.

Changes:

  • Add explicit language tags (e.g., text) and spacing around fenced code blocks that show command output.
  • Adjust heading levels/names to fix heading order and reduce ambiguity.
  • Minor wording/link text cleanups for readability.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
content/guides/using-the-app-catalog.mdx Labels previously unlabeled output blocks as text and normalizes fence spacing.
content/guides/overview.mdx Minor inline command formatting improvement (curl).
content/guides/internals.mdx Reflows prose and splits command/output blocks into console + text fenced sections.
content/guides/debugging.mdx Improves link phrasing and reflows a few list items.
content/guides/catalog-using-firecracker.mdx Labels an output block as text and fixes fence spacing inside a list item.
content/guides/catalog-behind-the-scenes.mdx Renames headings, labels output blocks as text, and adjusts list formatting.
content/guides/bincompat.mdx Fixes heading level order by promoting sections to ##.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread content/guides/internals.mdx Outdated
Comment thread content/guides/internals.mdx Outdated
Comment thread content/guides/internals.mdx Outdated
Comment thread content/guides/catalog-behind-the-scenes.mdx Outdated
Comment thread content/guides/debugging.mdx Outdated
Comment thread content/guides/catalog-behind-the-scenes.mdx
@ericsandu ericsandu force-pushed the ericsandu/fix-guides-linter branch 2 times, most recently from 902c177 to 33f06b4 Compare April 25, 2026 17:17
@razvand razvand self-requested a review May 2, 2026 11:44
@razvand razvand self-assigned this May 2, 2026
@razvand razvand added the enhancement New feature or request label May 2, 2026
Copy link
Copy Markdown
Contributor

@razvand razvand left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also fix these issues in the guides/:

$ npx markdownlint --config .github/workflows/config/config.json --rules .github/workflows/rules/rules.js content/guides/*
npm warn Unknown project config "strict-peer-dependencies". This will stop working in the next major version of npm. See `npm help npmrc` for supported config options.
content/guides/advanced-porting.mdx:13 error MD001/heading-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]
content/guides/advanced-porting.mdx:407 error MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```console"]

Use your proper name both for sign-off and for authorship in commits. Use Eric Sandu <eric_andrei.sandu@stud.acs.upb.ro>.

Start comment title line with a capital. That is, instead of feat(guides): fix linter errors ... use feat(guides): Fix linter errors ... (with capital F - Fix instead of fix).

@ericsandu ericsandu force-pushed the ericsandu/fix-guides-linter branch from 33f06b4 to ead0b5c Compare May 3, 2026 08:47
@razvand razvand self-requested a review May 3, 2026 10:10
Copy link
Copy Markdown
Contributor

@razvand razvand left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use your proper name for authorship in commits. Use Eric Sandu <eric_andrei.sandu@stud.acs.upb.ro>. You only used it for signed-off-by messages.

ericsandu added 8 commits May 3, 2026 13:21
Signed-off-by: Eric Sandu <eric_andrei.sandu@stud.acs.upb.ro>
…ation Catalog" guide

Has a leftover error caused by the use of "i.e." being treated as
multiple sentences.

Signed-off-by: Eric Sandu <eric_andrei.sandu@stud.acs.upb.ro>
…ion Catalog" guide

Signed-off-by: Eric Sandu <eric_andrei.sandu@stud.acs.upb.ro>
Has a leftover error caused by the use of a dot and question mark in the
header being treated as multiple sentences.

Signed-off-by: Eric Sandu <eric_andrei.sandu@stud.acs.upb.ro>
…guide

Has a leftover error caused by ellipsis being treated as multiple sentences.

Signed-off-by: Eric Sandu <eric_andrei.sandu@stud.acs.upb.ro>
Signed-off-by: Eric Sandu <eric_andrei.sandu@stud.acs.upb.ro>
Signed-off-by: Eric Sandu <eric_andrei.sandu@stud.acs.upb.ro>
…Unikraft"

Signed-off-by: Eric Sandu <eric_andrei.sandu@stud.acs.upb.ro>
@ericsandu ericsandu force-pushed the ericsandu/fix-guides-linter branch from ead0b5c to 3c7c503 Compare May 3, 2026 10:24
@ericsandu ericsandu requested a review from razvand May 3, 2026 10:25
Copy link
Copy Markdown
Contributor

@razvand razvand left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed-by: Razvan Deaconescu razvand@unikraft.io
Approved-by: Razvan Deaconescu razvand@unikraft.io

@razvand razvand merged commit ef30b32 into unikraft:main May 3, 2026
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants