Skip to content

Fix formatting inconsistencies across markdown files #515

@BekahHW

Description

@BekahHW

Description

Various markdown files throughout the repository have inconsistent formatting that should be standardized for better readability and maintainability.

Issues Identified

  • Inconsistent heading levels and hierarchy
  • Mixed indentation styles in lists
  • Inconsistent table formatting
  • Varied code block formatting
  • Inconsistent link formatting
  • Mixed quote styles

Tasks

  • Run npm run format to catch basic formatting issues
  • Manually review files for structural inconsistencies
  • Standardize heading hierarchy (ensure proper H1 → H2 → H3 flow)
  • Fix indentation in nested lists
  • Standardize table formatting
  • Ensure consistent code block language tags
  • Fix any malformed links or references

Files That Need Attention

  • Files in docs/monthly-challenges/ have varied formatting styles
  • docs/lightning-talks/ contains mixed formatting patterns
  • Various procedure files need standardization

Acceptance Criteria

  • All markdown files follow consistent formatting rules
  • npm run check passes without formatting errors
  • Documentation is easier to read and maintain
  • Future contributors have clear formatting examples to follow

Resources

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocsAddressing VC docsUp for GrabsAvailable for a contributor

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions