feat(Compass): add handbook doc page #4877
Open
Conversation
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
Collaborator
edonehoo
requested changes
Dec 17, 2025
Collaborator
edonehoo
left a comment
There was a problem hiding this comment.
some rearranging, syntax, and phrasing things. Lmk if I can clarify anything and feel free to make additional adjustments based on your own expertise/familiarity here!
packages/documentation-site/patternfly-docs/content/AI/Compass/CompassHandbook.md
Outdated
Show resolved
Hide resolved
packages/documentation-site/patternfly-docs/content/AI/Compass/CompassHandbook.md
Outdated
Show resolved
Hide resolved
packages/documentation-site/patternfly-docs/content/AI/Compass/CompassHandbook.md
Outdated
Show resolved
Hide resolved
packages/documentation-site/patternfly-docs/content/AI/Compass/CompassHandbook.md
Outdated
Show resolved
Hide resolved
packages/documentation-site/patternfly-docs/content/AI/Compass/CompassHandbook.md
Outdated
Show resolved
Hide resolved
packages/documentation-site/patternfly-docs/content/AI/Compass/CompassHandbook.md
Outdated
Show resolved
Hide resolved
packages/documentation-site/patternfly-docs/content/AI/Compass/CompassHandbook.md
Outdated
Show resolved
Hide resolved
packages/documentation-site/patternfly-docs/content/AI/Compass/CompassHandbook.md
Outdated
Show resolved
Hide resolved
packages/documentation-site/patternfly-docs/content/AI/Compass/CompassHandbook.md
Outdated
Show resolved
Hide resolved
packages/documentation-site/patternfly-docs/content/AI/Compass/CompassHandbook.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Erin Donehoo <[email protected]>
edonehoo
reviewed
Jan 5, 2026
Collaborator
edonehoo
left a comment
There was a problem hiding this comment.
couple of final little nits, otherwise this doc looks pretty good to me
| subsection: Generative UIs | ||
| --- | ||
|
|
||
| When building generative UI layouts using the Compass components, there are several common patterns to considering during your development. |
Collaborator
There was a problem hiding this comment.
Suggested change
| When building generative UI layouts using the Compass components, there are several common patterns to considering during your development. | |
| When building generative UI layouts using the Compass components, there are several common patterns to consider during your development process. |
|
|
||
| When building generative UI layouts using the Compass components, there are several common patterns to considering during your development. | ||
|
|
||
| ## Structural patterns |
Collaborator
There was a problem hiding this comment.
Suggested change
| ## Structural patterns |
moving this above the intro line
| source: Development-guide | ||
| subsection: Generative UIs | ||
| --- | ||
|
|
Collaborator
There was a problem hiding this comment.
Suggested change
| ## Structural patterns |
|
|
||
| Within Compass layouts, elements with a transparent glass background and rounded borders should be wrapped in a `<CompassPanel>` (some Compass components do this automatically). You can adjust various options of the `<CompassPanel>` to adapt its padding and behavior to fit the context of your use case. | ||
|
|
||
| To prevent styling issues, do not nest`<CompassPanel>` components while using the glass effects. |
Collaborator
There was a problem hiding this comment.
Suggested change
| To prevent styling issues, do not nest`<CompassPanel>` components while using the glass effects. | |
| To prevent styling issues, do not nest `<CompassPanel>` components while using the glass effects. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Closes #4838.