Uploaded image for project: 'Core Server'
  1. Core Server
  2. SERVER-97611

Markdown formatting and linting

    • Type: Icon: Improvement Improvement
    • Resolution: Unresolved
    • Priority: Icon: Major - P3 Major - P3
    • None
    • Affects Version/s: None
    • Component/s: None
    • None
    • Correctness
    • 2024-12-24, 2025-01-07, 2025-01-21

      We have no formatting or linting rules for Markdown that I know of

      We have enough .md files in our repo that we should start to impose more consistent formatting rules. Linting would prevent common mistakes. Suggestions:

      • Maximum column widths
      • Lint broken links
      • Lint hardlinks to the Github repo that could be relative links. I.e. linking to another README file section

            Assignee:
            steve.mcclure@mongodb.com Steve McClure
            Reporter:
            louis.williams@mongodb.com Louis Williams
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated: