Add autodoc CI automation
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 970
- Forks
- 486
- Avg merge
- 3d 33m
- Merged PRs (30d)
- 170
Description
Description
Autodoc is an automated documentation pipeline that triggers when a GitHub Epic issue closes, or any other issue with a Doc Needed tag.
It uses Claude (headless, via the Claude Code CLI) to assess whether the Epic's delivery requires new or updated documentation in the dotCMS docs site. Claude runs a semantic search against the dotCMS AI search API to check existing coverage, makes a triage determination, and if documentation is warranted, drafts the full content and saves it as a working draft in dotCMS for human review.
The result is posted as a comment on the triggering issue and committed to the repository. No content is published without explicit human approval.
Acceptance Criteria
- This automation better work.
Priority
Low
Additional Context
No response
Contributor guide
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 locating the CI automation entry point for GitHub Epic closures and issues with the Doc Needed tag, then trace its Claude Code CLI, dotCMS AI search API, docs-site draft, comment, and repository steps. Before implementation, clarify the acceptance criteria beyond “This automation better work”; done should include a verified end-to-end run with human approval required before publication.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions
- Domain
- devops, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100