Skip to content

Guided Steps component: View code, commands etc. with instructions on the side - #340

Open
aatuvai wants to merge 31 commits into
mainfrom
aatuvai/guided-steps
Open

aatuvai wants to merge 31 commits into
mainfrom
aatuvai/guided-steps

Conversation

@aatuvai

@aatuvai aatuvai commented Aug 28, 2025

Copy link
Copy Markdown
Contributor

This PR adds the GuidedSteps component, which can be used to view code along descriptive text on the side.

Five complimenting components are added with the GuidedSteps component:

  • Step: Used to place instruction steps to the GuidedSteps component.
  • StepSection: Starts a new section of Step instructions.
  • 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 instruction Step is 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:

  • The main GuidedSteps component can contain as direct children:
  1. Any .md content blocks
  2. Step, StepSection, and File blocks
  3. The File block can only contain CodeBlock blocks

Additionally:

  • Each Step needs to have an id that matches a CodeBlock (with the stepId property).

@github-actions

github-actions Bot commented Aug 28, 2025

Copy link
Copy Markdown

Amplify deployment status

Branch Commit Job ID Status Preview Updated (UTC)
aatuvai/guided-steps bceeba7 30 ✅SUCCEED aatuvai-guided-steps 2026-02-17 15:19:19

@aatuvai

aatuvai commented Sep 30, 2025

Copy link
Copy Markdown
Contributor Author

Preview on this page

@aatuvai
aatuvai marked this pull request as ready for review September 30, 2025 09:53
@aatuvai
aatuvai force-pushed the aatuvai/guided-steps branch from e37c451 to cce0b9f Compare November 24, 2025 11:02
Comment thread config.json
Comment on lines +9 to +10
"branch": "aatuvai/guided-steps",
"repo_path": "aatuvai/teleport",

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Revert before merge

@ptgott

ptgott commented Dec 1, 2025

Copy link
Copy Markdown
Contributor

Is there a way to split this one up?

For example, it seems like we could review and merge the Checkpoint component separately from the side-by-side layout component.

@aatuvai

aatuvai commented Dec 2, 2025

Copy link
Copy Markdown
Contributor Author

Is there a way to split this one up?

For example, it seems like we could review and merge the Checkpoint component separately from the side-by-side layout component.

@ptgott Yeah I think you are right, it makes sense to review the Checkpoint in a separate PR. Thanks

This branch was previously deployed

1 inactive deployment
docs-amplify bceeba7e Deployed Feb 17, 2026 by aatuvai via Amplify Preview #1353
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.

2 participants