-
Notifications
You must be signed in to change notification settings - Fork 5
Guided Steps component: View code, commands etc. with instructions on the side #340
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.
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
base: main
Are you sure you want to change the base?
Conversation
|
Amplify deployment status
|
|
Preview on this page |
e37c451 to
cce0b9f
Compare
| "branch": "aatuvai/guided-steps", | ||
| "repo_path": "aatuvai/teleport", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Revert before merge
|
Is there a way to split this one up? For example, it seems like we could review and merge the |
@ptgott Yeah I think you are right, it makes sense to review the |
…tyle to active step
22a1ba1 to
25434aa
Compare
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).