Skip to content

Conversation

@cdcabrera
Copy link
Member

@cdcabrera cdcabrera commented Jan 16, 2026

What is it?

  • docs: usage, development, and agent guidance
    • build, spell check for code and docs
    • build, lint for code examples
    • readme, break into related documents
    • contributing, add user guidelines
    • docs, create new repo directory
    • docs architecture, MCP server state, roadmap
    • docs development, how to use the MCP server for development
    • docs examples, base examples for using the MCP server
    • docs usage, general MCP server usage
    • guidelines, agent codebase interaction guidance

Notes

  • STILL REQUIRES, review and the entire guidelines directory for agents before merge
  • Retains some of the existing README.md content, just better breakdown.
  • Adds in
    • basic architecture, current and future
    • basic roadmap
    • expanded development docs and examples
    • agent guidance for interacting with the codebase
  • Adds in a spell checker as part of the ci tests
  • Code examples are lint by the codebase configuration
  • Closes Refine and expand repository level documentation #39

@cdcabrera cdcabrera force-pushed the 20260116-issue-39 branch 2 times, most recently from a96d906 to 63a2b38 Compare January 19, 2026 03:34
@cdcabrera cdcabrera mentioned this pull request Jan 19, 2026
@cdcabrera
Copy link
Member Author

Move the typing update to an independent PR. It needs to be moved in as part of the 0.6.0 release.

@cdcabrera cdcabrera force-pushed the 20260116-issue-39 branch 8 times, most recently from b45dcff to ffaeb3b Compare January 21, 2026 20:48
* build, spell check for code and docs
* build, lint for code examples
* readme, break into related documents
* contributing, add user guidelines
* docs, create new repo directory
* docs architecture, MCP server state, roadmap
* docs development, how to use the MCP server for development
* docs examples, base examples for using the MCP server
* docs usage, general MCP server usage
* guidelines, agent codebase interaction guidance
@cdcabrera cdcabrera marked this pull request as ready for review January 21, 2026 20:52
@cdcabrera cdcabrera merged commit 1d69fcd into patternfly:main Jan 21, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Refine and expand repository level documentation

1 participant