misc: Docs Update + Other non-functional changes

[tzaffi]

I pulled out the doc updates from draft PR #83 and also fixed a couple of scoping issues in our tests.

Summary of Changes

• Introducing .markdownlint.yml. This isn't enforced in CI but while using the VS Code extension it helped me identify some bugs in our docs. For example, some improperly formatted list items.
• Small edits in the following docs:
  • docs/Configuration.md
  • docs/Development.md
  • docs/GettingStarted.md
  • docs/tutorials/WritingBlocksToFile.md
• loop variable capture fixes in:
  • conduit/pipeline/pipeline_test.go
  • conduit/plugins/importers/algod/algod_importer_test.go (also tightening the test expectations around the genesis object received from Init())

TODO

• Shall we add exportloopref to our linters?

linters:
  enable:
    - exportloopref

[codecov]

Codecov Report

Merging #87 (cbe1692) into master (442791a) will increase coverage by 1.59%.
The diff coverage is 75.40%.

❗ Current head cbe1692 differs from pull request most recent head ce68165. Consider uploading reports for the commit ce68165 to get more accurate results

@@            Coverage Diff             @@
##           master      #87      +/-   ##
==========================================
+ Coverage   67.66%   69.25%   +1.59%     
==========================================
  Files          32       36       +4     
  Lines        1976     2417     +441     
==========================================
+ Hits         1337     1674     +337     
- Misses        570      651      +81     
- Partials       69       92      +23     

Impacted Files	Coverage Δ
conduit/data/block_export_data.go	100.00% <ø> (+92.30%)	⬆️
conduit/plugins/importers/algod/metrics.go	100.00% <ø> (ø)
...plugins/processors/filterprocessor/gen/generate.go	34.28% <ø> (ø)
pkg/cli/internal/list/list.go	20.75% <ø> (ø)
...lugins/exporters/postgresql/postgresql_exporter.go	66.66% <51.21%> (-11.54%)	⬇️
pkg/cli/cli.go	65.97% <65.97%> (ø)
conduit/pipeline/pipeline.go	66.18% <72.48%> (+0.72%)	⬆️
conduit/data/config.go	76.47% <76.47%> (ø)
conduit/plugins/importers/algod/algod_importer.go	88.60% <91.45%> (+0.29%)	⬆️
conduit/pipeline/errors.go	100.00% <100.00%> (ø)
... and 4 more

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[algochoi]

Looks like good changes to me!

[algochoi]

I personally use VSCode so I am fine with this change but wondering what others think about adding IDE/editor/extension specific config files in the root dir.

[tzaffi]

What do you think about adding exportloopref ?

[algochoi]

I only looked at the README but it looks like a good addition to me and the benefits seem to outweigh the possibilities of false negatives

[tzaffi]

see cbe1692

FYI - it didn't actually catch the problem. But we're also using it in go-algorand so it should be safe.