-
One of a multi-part series of changes to improve markdown code quality, primarily driven by feedback from codeclimate's markdownlint plugin. This MR resolves markdown issues with header styles: - All files must begin with a top-level header - There must only be one top-level header - Header styles must be consistent throughout a file - both SETEXT and ATX styles are acceptable, but must be the same. Where more than two header levels are present, SETEXT is replaced with ATX for consistency (as third-level and below headers don't exist in SETEXT style). - No trailing punctuation in headers - There must be whitespace surrounding a header This also resolves the following miscellaneous issues: - Fixing quotes for correct rendering Test plan --------- - review document changes - Run codeclimate locally to verify rule violations have been addressed: docker run --interactive --tty --rm --env CODECLIMATE_CODE="$PWD" --volume "$PWD":/code --volume /var/run/docker.sock:/var/run/docker.sock --volume /tmp/cc:/tmp/cc codeclimate/codeclimate analyze - run ninja doc-html on master, take a backup, and run it again on this branch - run recursive diff to verify no unexpected changes appear in the generated HTML for files where differences occur, compare changed locations in generated doc/html/index.html with a browser to content generated on master, and to content on https://docs.bitcoincashnode.org (not all changed documents are present there, the ones that are not can be treated as out of scope of this comparison)
One of a multi-part series of changes to improve markdown code quality, primarily driven by feedback from codeclimate's markdownlint plugin. This MR resolves markdown issues with header styles: - All files must begin with a top-level header - There must only be one top-level header - Header styles must be consistent throughout a file - both SETEXT and ATX styles are acceptable, but must be the same. Where more than two header levels are present, SETEXT is replaced with ATX for consistency (as third-level and below headers don't exist in SETEXT style). - No trailing punctuation in headers - There must be whitespace surrounding a header This also resolves the following miscellaneous issues: - Fixing quotes for correct rendering Test plan --------- - review document changes - Run codeclimate locally to verify rule violations have been addressed: docker run --interactive --tty --rm --env CODECLIMATE_CODE="$PWD" --volume "$PWD":/code --volume /var/run/docker.sock:/var/run/docker.sock --volume /tmp/cc:/tmp/cc codeclimate/codeclimate analyze - run ninja doc-html on master, take a backup, and run it again on this branch - run recursive diff to verify no unexpected changes appear in the generated HTML for files where differences occur, compare changed locations in generated doc/html/index.html with a browser to content generated on master, and to content on https://docs.bitcoincashnode.org (not all changed documents are present there, the ones that are not can be treated as out of scope of this comparison)
Loading