docs: Add project file for Claude documentation skill integration#6284
Open
clayton-cornell wants to merge 1 commit into
Open
docs: Add project file for Claude documentation skill integration#6284clayton-cornell wants to merge 1 commit into
clayton-cornell wants to merge 1 commit into
Conversation
clayton-cornell
added
the
type/docs
clayton-cornell
changed the title
thampiotr
reviewed
May 20, 2026
Contributor
thampiotr
left a comment
thampiotr
left a comment
There was a problem hiding this comment.
In case we use something other than Claude, would this be detected?
I'm thinking we should maybe link to this doc from docs-writing.md or from AGENTS.md
Contributor
Author
project-context.md is for Claude. It functions in the same general way that copilot-instructions.md does. Content-wise it's just a markdown file and the content can be referenced by most AI engines if you explicitly call it out.
We could do that in the future. The docs-ai repo isn't public yet. An alternative if we don't want to push to the Alloy repo is I keep it local and add the filename to git ignore. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds the project-context.md file that is used by the documentation skill integrations. This file can be used by anyone within Grafana contributing to the Alloy docs in combination with the Claude skills defined in the docs-ai repo.
This file should have no impact for anyone (community or Grafana) that does not use the skills for doc maintenance.