Skip to content

docs: fix markdownlint warnings and refine documentation files - #27

Merged
TheDevConnor merged 1 commit into
Luma-Programming-Language:self-hostedfrom
renan-cm-apolo:fix-docs-markdown
Sep 14, 2026
Merged

TheDevConnor merged 1 commit into
Luma-Programming-Language:self-hostedfrom
renan-cm-apolo:fix-docs-markdown

Conversation

@renan-cm-apolo

Copy link
Copy Markdown
Contributor

Description

This PR fixes Markdown formatting errors, lint warnings, and inconsistencies across Luma's documentation files.

Changes

Fixed markdownlint warnings and formatting issues, including:

  • Corrected heading hierarchy and list item prefixes (MD029)
  • Fixed unlabelled code blocks and dangling URLs
  • Cleaned up trailing whitespace and list spacing
  • Updated build, installation, and testing command instructions
  • Corrected paths and setup instructions for Windows, Linux, and macOS
  • Removed outdated references (generics, LLVM, Meson, Ninja)
  • Fixed typos and improved grammar across docs
  • Refined release notes for v0.3.4 and v0.3.5, and synced TODO with implemented features

Validation

  • Verified zero diagnostic/lint errors across revised .md files in VS Code
  • Executed git diff --check with no whitespace or formatting errors
  • Checked and balanced all Markdown code blocks

@TheDevConnor

Copy link
Copy Markdown
Collaborator

LGTM. Thank you for going through and fixing my spelling mistakes as well!

@TheDevConnor
TheDevConnor merged commit 8585c8e into Luma-Programming-Language:self-hosted Sep 14, 2026
@renan-cm-apolo

Copy link
Copy Markdown
Contributor Author

You're welcome! Happy to help clean things up. I'm looking forward to contributing more to Luma soon!

@renan-cm-apolo
renan-cm-apolo deleted the fix-docs-markdown branch September 14, 2026 22:50
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.

2 participants