Skip to content

Add CLAUDE.md for Claude Code AI assistant guidance#111482

Open
kquinn1204 wants to merge 1 commit into
openshift:mainfrom
kquinn1204:add-claude-md-file
Open

Add CLAUDE.md for Claude Code AI assistant guidance#111482
kquinn1204 wants to merge 1 commit into
openshift:mainfrom
kquinn1204:add-claude-md-file

Conversation

@kquinn1204
Copy link
Copy Markdown
Contributor

Add a CLAUDE.md file that provides project-specific guidance to the Claude Code AI assistant when working with the openshift-docs repository.

The file documents:

  • Build and validation commands (AsciiBinder, Vale, make)
  • Repository architecture (topic maps, distros, assembly/module pattern, attributes)
  • Documentation standards (ventilated prose, sentence case headings, module content types, no callouts, attributes over hardcoding)
  • Git workflow conventions

This helps contributors who use Claude Code get contextually accurate suggestions that follow openshift-docs conventions, reducing review churn from AI-assisted contributions.

@openshift-ci openshift-ci Bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label May 11, 2026
@ocpdocs-previewbot
Copy link
Copy Markdown

🤖 Mon May 11 08:39:27 - Prow CI generated the docs preview:

https://111482--ocpdocs-pr.netlify.app/

@openshift-ci
Copy link
Copy Markdown

openshift-ci Bot commented May 11, 2026

@kquinn1204: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants