-
-
Notifications
You must be signed in to change notification settings - Fork 4
Open
Labels
DocsAddressing VC docsAddressing VC docsUp for GrabsAvailable for a contributorAvailable for a contributor
Description
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 formatto 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 checkpasses without formatting errors - Documentation is easier to read and maintain
- Future contributors have clear formatting examples to follow
Resources
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
DocsAddressing VC docsAddressing VC docsUp for GrabsAvailable for a contributorAvailable for a contributor