wayfair-incubator / aux-eng-playbook

Wayfair Tech's playbook for building and supporting an Auxiliary Engineering program.

BSD Zero Clause License

4 stars 1 forks source link

Closed lelia closed 2 years ago

lelia commented 2 years ago

Given the majority of documentation content here is written in Markdown, we should be linting our .md files.

Changes

Updates and expands the existing .markdownlint.json configuration
Adds avto-dev/markdown-lint action to the existing .github/lint.yml workflow
Fixes all current markdownlint violations under /src/docs and the repo root

GaryPWhite commented 2 years ago

you may want to rewind / rebase this -- I think it's based on your renovate branch and will conflict when we merge it (maybe)

GaryPWhite commented 2 years ago

either way it's hard to tell what's being edited here when those changes are also present :)

lelia commented 2 years ago

you may want to rewind / rebase this -- I think it's based on your renovate branch and will conflict when we merge it (maybe)

Indeedy - hence the note:

⚠️ Branched from https://github.com/wayfair-incubator/auxeng-docs/pull/27, which should be merged first.

If it's easier, let's just hold off on reviewing this until #27 is merged so I can update this branch from main.

GaryPWhite commented 2 years ago

i cant read ya that's ok

lelia commented 2 years ago

@GaryPWhite Should be ready for review now!