Investigate GitBook interactions with MDFormat

[tsande16]

What?

Investigate how GitBook will interact with a linter and pre-commit hook, such as MDFormat. In addition ensure that MDFormat can enforce line wrapping or remove line wrapping.

Why?

Using a linter can improve documentation style, consistency, and readability. Having a tool that can enforce this for us will ensure consistency between GitBook and developers.

How?

• In a test GitHub account setup MDFormat and configure a pre-commit hook.
• Perform tests on merging commits from GitBook into GitHub.

Acceptance Criteria

• Examples of MDFormat enforcing different configurations of line wrapping using a pre-commit hook in GitHub.
• Disseminate findings with team

[tsande16]

Discussed with Bill. This will be part of our CI process. Will work on this after first initial documentation is in production.

[tsande16]

For right now, the decision is to use the original author's style. GitBook will override this, but at least in this moment it's not anticipated there will be much overriding of style. This can still be investigated in the future if it becomes a priority.