redhat-et / redhat-et/docsclaw
Markdown linter for agent output quality
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 2
- Forks
- 1
- Avg merge
- 6h 9m
- Merged PRs (30d)
- 1
Description
Summary
Integrate a Markdown linter so DocsClaw agents can validate and clean up their own Markdown output.
Motivation
DocsClaw agents often produce Markdown documents (summaries, reports, converted content). A built-in linting step ensures consistent, well-formed output without relying on the LLM to get formatting right every time.
Implementation options
- CLI tool in the image — bundle
markdownlint-cliand invoke viaexecas a post-processing step - Built-in tool — add a
lint_markdowntool that runs markdownlint on a file and returns violations - Skill-based — provide a SKILL.md that instructs the agent to lint its own output before finalizing
Option 2 is probably the most useful — the agent can lint, see violations, and fix them in the agentic loop.
Acceptance criteria
- Agent can lint Markdown files it produces
- Linting rules configurable via
.markdownlint.yamlin the config directory - Works in the docs and content image flavors at minimum
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the three implementation options, with particular attention to the proposed lint_markdown tool and the existing config directory. Check how the docs and content image flavors are defined and where markdownlint-cli could run. Done means Markdown files can be linted, .markdownlint.yaml rules are honored, and both flavors support the workflow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- content, documentation, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100