docs: normalize onboarding steps indentation#14
Conversation
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on enhancing the readability and maintainability of the onboarding documentation. By applying consistent indentation to the step-by-step instructions, the changes ensure that the markup nesting is clear and easy to parse, contributing to a better user experience for anyone reviewing the documentation. Highlights
Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request aims to normalize indentation for <Step> components in datzi/start/onboarding.mdx, but the change is incomplete. Several <Step> components in the same file have been missed, leaving the markup in an inconsistent state. To fully achieve the goal of consistent formatting, all <Step> children of <Steps> should be indented.
| <Step title="Approve macOS warning"> | ||
| <Frame> | ||
| <img alt="MacOS security warning dialog during onboarding approval" /> | ||
| </Frame> | ||
| </Step> |
There was a problem hiding this comment.
This change is incomplete. The goal of this PR is to normalize indentation for <Step> components, but several others within this <Steps> block remain unindented. This leaves the file in an inconsistent state. To complete this change, please indent all direct children of <Steps> for consistency. The unindented <Step> tags can be found on lines 24, 30, and 77.
There was a problem hiding this comment.
Copilot wasn't able to review any files in this pull request.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
| </Frame> | ||
| </Step> | ||
|
|
||
| <Step title="Approve find local networks"> | ||
| <Frame> |
| </Step> | ||
| <Step title="Approve macOS warning"> | ||
| <Frame> | ||
| <img alt="MacOS security warning dialog during onboarding approval" /> |
Fix formatting of the Steps/Step block in datzi/start/onboarding.mdx so markup nesting is consistent and easy to parse.