CI for techdocs is currently handled in its own workflow. This workflow runs the techdocs image directly for validation. This is fine for CI but it adds friction for a developer if they want to validate their changes locally. The developer must either run the same docker compose command or copy the techdocs prettierrc/markdownlint.yml files into their repo and manually run the commands. Remembering to use a separate command for techdocs isn't a hassle, but it's one more thing to remember. It is also not obvious that there is a validate-fix target, which may lead to the developer manually copying files and running linters/formatters directly.
An ideal result would be two new mage targets: docs:lint and docs:fix. These would be wrappers for the techdocs make targets validate and validate-fix respectively. All (if not most) repos have documentation, so it makes sense that techdocs has the same support as go and kubernetes.
CI for techdocs is currently handled in its own workflow. This workflow runs the techdocs image directly for validation. This is fine for CI but it adds friction for a developer if they want to validate their changes locally. The developer must either run the same docker compose command or copy the techdocs prettierrc/markdownlint.yml files into their repo and manually run the commands. Remembering to use a separate command for techdocs isn't a hassle, but it's one more thing to remember. It is also not obvious that there is a
validate-fixtarget, which may lead to the developer manually copying files and running linters/formatters directly.An ideal result would be two new mage targets:
docs:lintanddocs:fix. These would be wrappers for the techdocs make targetsvalidateandvalidate-fixrespectively. All (if not most) repos have documentation, so it makes sense that techdocs has the same support as go and kubernetes.