Skip to content

chore(Compass): move docs to 'components'#12403

Open
nicolethoen wants to merge 1 commit intopatternfly:mainfrom
nicolethoen:move_compass_docs
Open

chore(Compass): move docs to 'components'#12403
nicolethoen wants to merge 1 commit intopatternfly:mainfrom
nicolethoen:move_compass_docs

Conversation

@nicolethoen
Copy link
Copy Markdown
Contributor

@nicolethoen nicolethoen commented May 1, 2026

What: Closes https://redhat.atlassian.net/browse/PF-4080

Moves compass component docs and demos to Components section and removes AI / generative AI sections from react workspace

Summary by CodeRabbit

  • Documentation
    • Reorganized Compass component documentation by reclassifying it from the AI section to the components section.
    • Updated the documentation navigation menu by removing the AI section.

@nicolethoen nicolethoen requested review from a team, thatblindgeye and wise-king-sullyman and removed request for a team May 1, 2026 01:56
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 1, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: c0c45e9e-82ce-4be6-bdb1-d9176f9c8901

📥 Commits

Reviewing files that changed from the base of the PR and between e47cb62 and 8d6b042.

📒 Files selected for processing (3)
  • packages/react-core/src/components/Compass/examples/Compass.md
  • packages/react-core/src/demos/Compass/Compass.md
  • packages/react-docs/patternfly-docs/patternfly-docs.config.js
💤 Files with no reviewable changes (1)
  • packages/react-docs/patternfly-docs/patternfly-docs.config.js

Walkthrough

The PR reclassifies Compass documentation from the AI/Generative UIs section to the main components section by updating MDX frontmatter in two documentation files and removing the AI section from the documentation site's side navigation configuration.

Changes

Cohort / File(s) Summary
Compass Documentation Frontmatter
packages/react-core/src/components/Compass/examples/Compass.md, packages/react-core/src/demos/Compass/Compass.md
Updated MDX metadata to change section classification from AI / Generative UIs to section: components.
Documentation Configuration
packages/react-docs/patternfly-docs/patternfly-docs.config.js
Removed the AI section entry from sideNavItems array, eliminating the AI documentation section from the side navigation menu.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related issues

Possibly related PRs

Suggested reviewers

  • mcoker
  • kmcfaul
  • andrew-ronaldson
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main change: moving Compass documentation from the AI section to the components section across multiple files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
Review rate limit: 7/8 reviews remaining, refill in 7 minutes and 30 seconds.

Comment @coderabbitai help to get the list of available commands and usage tips.

@patternfly-build
Copy link
Copy Markdown
Collaborator

patternfly-build commented May 1, 2026

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.

3 participants