Open
Conversation
Adding more detail to installation instructions
wesleyboar
reviewed
Mar 5, 2026
Contributor
wesleyboar
left a comment
wesleyboar
left a comment
There was a problem hiding this comment.
This would have been helpful my first time installing it. Thanks for proposing these changes. I hope the maintainers sees it.
Comment on lines
+115
to
+117
| If you need a **browser-ready, non-React embed**, see the related repository: | ||
|
|
||
| - https://github.com/TACC/cfde-wheel-embed |
Contributor
There was a problem hiding this comment.
Thanks for the mention. Technically, TACC/cfde-wheel-embed uses React; but embeds it so end user need not.
Suggested change
| If you need a **browser-ready, non-React embed**, see the related repository: | |
| - https://github.com/TACC/cfde-wheel-embed | |
| If you need a **browser-ready embed**, see the related repository: | |
| - https://github.com/TACC/cfde-wheel-embed |
Comment on lines
+128
to
+130
| <aside> | ||
| <CFDEWheel /> | ||
| </aside> |
Contributor
There was a problem hiding this comment.
Good choice of element (<aside>). 👍
Comment on lines
+14
to
+16
|
|
||
| --- | ||
|
|
Contributor
There was a problem hiding this comment.
(Opinion) These --- seem superfluous, and add extra space noticeable by users with small screens or resolutions. I propose relying on the headers alone to signal a new section, not adding ---.
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.
Adding more detail to installation instructions