Skip to content

chore(docs): add codemods, getting started guides #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cdcabrera merged 2 commits into from
Mar 9, 2026
Merged

chore(docs): add codemods, getting started guides #124

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4fe693c
chore(docs): add codemods, getting started guides
cdcabrera Mar 7, 2026
a683b37
fix: review update
cdcabrera Mar 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/__tests__/__snapshots__/tool.searchPatternFlyDocs.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ exports[`searchPatternFlyDocsTool should have a consistent return structure: str

exports[`searchPatternFlyDocsTool, callback should parse parameters, default: search 1`] = `"# Search results for "Button". Showing 2 exact matches."`;

exports[`searchPatternFlyDocsTool, callback should parse parameters, with "*" searchQuery all: search 1`] = `"# Search results for "all" resources. Only showing the first 10 results. There are 732 potential match variations. Try searching with a more specific query."`;
exports[`searchPatternFlyDocsTool, callback should parse parameters, with "*" searchQuery all: search 1`] = `"# Search results for "all" resources. Only showing the first 10 results. There are 764 potential match variations. Try searching with a more specific query."`;

exports[`searchPatternFlyDocsTool, callback should parse parameters, with "all" searchQuery all: search 1`] = `"# Search results for "all" resources. Only showing the first 10 results. There are 732 potential match variations. Try searching with a more specific query."`;
exports[`searchPatternFlyDocsTool, callback should parse parameters, with "all" searchQuery all: search 1`] = `"# Search results for "all" resources. Only showing the first 10 results. There are 764 potential match variations. Try searching with a more specific query."`;

exports[`searchPatternFlyDocsTool, callback should parse parameters, with explicit valid version: search 1`] = `"# Search results for "Button". Showing 2 exact matches."`;

Expand Down
10 changes: 4 additions & 6 deletions src/__tests__/docs.json.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,8 @@ describe('docs.json', () => {

if (entry.path.includes('documentation:')) {
baseHashes.add('documentation:');
} else if (entry.path.includes('/patternfly/patternfly-org/')) {
baseHashes.add(entry.path.split('/patternfly/patternfly-org/')[1]?.split('/')[0]);
} else if (entry.path.includes('/patternfly/patternfly-react/')) {
baseHashes.add(entry.path.split('/patternfly/patternfly-react/')[1]?.split('/')[0]);
} else if (/^https:\/\/raw\.githubusercontent\.com\/patternfly\/p[a-zA-Z0-9-]+\//.test(entry.path)) {
baseHashes.add(entry.path.split(/\/patternfly\/p[a-zA-Z0-9-]+\//)[1]?.split('/')[0]);
} else {
baseHashes.add(`new-resource-${entry.path}`);
}
Expand All @@ -29,9 +27,9 @@ describe('docs.json', () => {
/**
* Confirm we have limited hashes, avoid variation within pf versions
* If this increases, hashes need to be realigned. Do not randomly change this value.
* 1 (v6 org) + 1 (v6 react) + 1 (v5 org) + 1 (local)
* 1 (v6 org) + 1 (v6 react) + 1 (v5 org) + 1 (codemods) + 1 (local)
*/
expect(baseHashes.size).toBe(4);
expect(baseHashes.size).toBe(5);

/**
* Confirm total docs count matches metadata
Expand Down
70 changes: 67 additions & 3 deletions src/docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
"version": "1",
"generated": "2026-03-05T00:00:00.000Z",
"meta": {
"totalEntries": 128,
"totalDocs": 305,
"totalEntries": 130,
"totalDocs": 311,
"source": "patternfly-mcp-internal"
},
"docs": {
Expand Down Expand Up @@ -3306,12 +3306,76 @@
"displayName": "Open UI Automation",
"description": "Open UI Automation (OUIA) is a specification for standardizing how UIs expose attributes for automated testing.",
"pathSlug": "openui-automation",
"section": "components",
"section": "upgrade",
"category": "react",
"source": "github",
"path": "https://raw.githubusercontent.com/patternfly/patternfly-react/476782a298df81cb78de7f3cd804f3ff8f33993c/packages/react-core/src/helpers/OUIA/OUIA.md",
"version": "v6"
}
],
"UpgradeGuide": [
{
"displayName": "PatternFly 6 upgrade guide",
"description": "PatternFly 6 introduces exciting new features and functionality. Before you upgrade, familiarize yourself with these significant changes.",
"pathSlug": "upgrade-guide-pf6",
"section": "upgrade",
"category": "react",
"source": "github",
"path": "https://raw.githubusercontent.com/patternfly/patternfly-org/2d5fec39ddb8aa32ce78c9a63cdfc1653692b193/packages/site/src/content/get-started/upgrade.mdx",
"version": "v6"
},
{
"displayName": "Codemods PatternFly 3 to PatternFly 4",
"description": "pf-codemods is an eslint wrapper to update @patternfly/react-core@3.x.x code to 4.x.x.",
"pathSlug": "codemods-pf4",
"section": "upgrade",
"category": "react",
"source": "github",
"path": "https://raw.githubusercontent.com/patternfly/pf-codemods/63df51df5cc6af2f3d83de4c0991c9e65625675f/packages/pf-codemods/v4-README.md",
"version": "v4"
},
{
"displayName": "Codemods PatternFly 4 to PatternFly 5",
"description": "pf-codemods is an eslint wrapper to update @patternfly/react-core@4.x.x code to 5.x.x.",
"pathSlug": "codemods-pf5",
"section": "upgrade",
"category": "react",
"source": "github",
"path": "https://raw.githubusercontent.com/patternfly/pf-codemods/63df51df5cc6af2f3d83de4c0991c9e65625675f/packages/pf-codemods/v5-README.md",
"version": "v5"
},
{
"displayName": "Codemods PatternFly 5 to PatternFly 6",
"description": "pf-codemods is an eslint wrapper to update @patternfly/react-core@5.x.x code to 6.x.x.",
"pathSlug": "codemods-pf6",
"section": "upgrade",
"category": "react",
"source": "github",
"path": "https://raw.githubusercontent.com/patternfly/pf-codemods/63df51df5cc6af2f3d83de4c0991c9e65625675f/packages/pf-codemods/README.md",
"version": "v6"
}
],
"GettingStarted": [
{
"displayName": "Design with PatternFly 6",
"description": "To start designing with PatternFly 6 you will need to install our PatternFly 6 design kit.",
"pathSlug": "design-with-patternfly",
"section": "getting-started",
"category": "design-guidelines",
"source": "github",
"path": "https://raw.githubusercontent.com/patternfly/patternfly-org/2d5fec39ddb8aa32ce78c9a63cdfc1653692b193/packages/documentation-site/patternfly-docs/content/get-started/design.md",
"version": "v6"
},
{
"displayName": "Develop with PatternFly 6",
"description": "To start developing with PatternFly 6 learn about our design system and tokens.",
"pathSlug": "develop-with-patternfly",
"section": "getting-started",
"category": "development-guidelines",
"source": "github",
"path": "https://raw.githubusercontent.com/patternfly/patternfly-org/2d5fec39ddb8aa32ce78c9a63cdfc1653692b193/packages/documentation-site/patternfly-docs/content/get-started/develop.md",
"version": "v6"
}
]
}
}
Loading