ci: add markdownlint job to CI

[GauravPawar101]

Add a markdownlint job that runs on all .md files using the igorshubovych/markdownlint-cli Docker image. Includes a config file to disable MD013 (line length) and MD003 (heading style) rules to avoid false positives on existing documentation.

Fixes #692

[alejandro-vaz]

why disable these??

shouldn't we just have it default??

maybe even remove the file

if changes are needed, we can tweak the documentation

[GauravPawar101]

Fixed some files and I think we should disable line length or bump it to 100 accordingly. The decision remains upto you

[alejandro-vaz]

thanks

[alejandro-vaz]

but we are failing that CI job though

what a nightmare

[GauravPawar101]

@alejandro-vaz that'swhat I am asking let's bump line len to 100 and then do those line changes as some are 150~

[alejandro-vaz]

nah I'd say normally split

it doesn't really matter whether it's 80 or 100 but setting it to a 100 is more cumbersome (wouldn't we have to add a markdownlint file??) and the resulting readme it's the same so why complicate it

[GauravPawar101]

@alejandro-vaz please take this into consideraton we would not be able to write appropriately with 80, too little headspace I recommend atleast a 100

Feature List

• allocator-api (nightly): uses the allocator-api backend -> cropped
• allocator-api2: uses the allocator-api2 backend for the allocator API -> dropped storing elements
• arbitrary: implements Arbitrary for any SmallVec that implement Arbitrary
• borsh: implements BorshSerialize, BorshDeserialize and BorshSchema
• bytes: implements BufMut for SmallVec
• defmt: implements defmt::Format for SmallVec
• encase: implements encasing as a runtime-sized array
• internals: exports through the public API LocatedLength and RawSmallVec
• malloc_size_of: implements MallocSizeOf and MallocShallowSizeOf
• rayon: implements parallel iteration
• serde: implements serde's serialization and deserialization
• specialization (nightly): enables specialization, improving performance on some cases -> LintErr as 89 instead of 80 might need to split similar on future revisions
• std: implements the std::io::Write type for SmallVec<u8, N>

Note

• SmallVec without any features enabled does not make use of the standard library.
• The rayon feature implicitly requires std.
• The allocator-api2 feature requires allocator-api

[GauravPawar101]

if as of now no separate config, we can do it in CI but that would not be appealing tho

[alejandro-vaz]

honestly I got lost

why can't we simply split??

I lost the thread of the argument

[GauravPawar101]

Wait a minute fixing

[alejandro-vaz]

hhahhah GOING GREEN best commit name I've ever seen brother

still didn't go green, markdownlint is hell

no worries, have time

[alejandro-vaz]

.github/CODE_OF_CONDUCT.md:3:88 MD047/single-trailing-newline Files should end with a single newline character
.github/CONTRIBUTING.md:1 MD041/first-line-heading/first-line-h1 First line in a file should be a top-level heading [Context: "## Contributing Guidelines"]
.github/README.md:4:81 MD013/line-length Line length [Expected: 80; Actual: 92]
.github/README.md:5:81 MD013/line-length Line length [Expected: 80; Actual: 139]
.github/README.md:6:2 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
.github/README.md:11:81 MD013/line-length Line length [Expected: 80; Actual: 162]
.github/README.md:26:1 MD033/no-inline-html Inline HTML [Element: a]
.github/README.md:27:3 MD033/no-inline-html Inline HTML [Element: img]
.github/README.md:27:3 MD045/no-alt-text Images should have alternate text (alt text)
.github/README.md:28:4 MD047/single-trailing-newline Files should end with a single newline character

[alejandro-vaz]

thanks @GauravPawar101, sorry for the long back-and-forth