Onboarding UX: Installation guide #43
Merged
Conversation
This file contains 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
Needed to upgrade astro/starlight in order to get <Aside> support.
- Restructure sections and make use of starlight framework components to minimize cognitive load. - Fix typo's, restructure and/or rephrase sentences to minimize ambiguity. - Avoid skipping heading levels. - Use shell instead of none/sh/bash blocks in order to support syntax highlighting.
|
Linking atuinsh/atuin#1798 |
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.
Mostly restructuring and rephrasing, see commit messages for details.
Upgraded Astro/Starlight dependencies in order to get
<Aside>support, which allows displaying warnings by using MDX components.Breaking changes: Please do note that some headings were changed. This may cause page anchors to break. I don't expect this to be much of an issue, as the doc is quite compact anyway.