Guided Steps component: View code, commands etc. with instructions on the side#340
Open
Guided Steps component: View code, commands etc. with instructions on the side#340
Conversation
|
Amplify deployment status
|
Contributor
Author
|
Preview on this page |
e37c451 to
cce0b9f
Compare
aatuvai
commented
Nov 24, 2025
Comment on lines
+9
to
+10
| "branch": "aatuvai/guided-steps", | ||
| "repo_path": "aatuvai/teleport", |
Contributor
Author
There was a problem hiding this comment.
Revert before merge
Contributor
|
Is there a way to split this one up? For example, it seems like we could review and merge the |
Contributor
Author
@ptgott Yeah I think you are right, it makes sense to review the |
…tyle to active step
22a1ba1 to
25434aa
Compare
…nctionality when screen room is limited
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
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.
This PR adds the
GuidedStepscomponent, which can be used to view code along descriptive text on the side.Five complimenting components are added with the
GuidedStepscomponent:Step: Used to place instruction steps to theGuidedStepscomponent.StepSection: Starts a new section ofStepinstructions.File: Groups the code of a particular file / type to its own tab.CodeBlock: marks the lines of code which should be highlighted when the associated instructionStepis active.Checkpoint: used to collect feedback from users while scrolling the code instruction guide (the component is added in Checkpoint component #477)Rules for
GuidedSteps:GuidedStepscomponent can contain as direct children:Step,StepSection, andFileblocksFileblock can only containCodeBlockblocksAdditionally:
Stepneeds to have anidthat matches aCodeBlock(with thestepIdproperty).