-
Notifications
You must be signed in to change notification settings - Fork 76
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
docs(install/3ds): Improve preamble section #289
Open
angeloanan
wants to merge
1
commit into
PretendoNetwork:dev
Choose a base branch
from
angeloanan:docs/3ds-preamble-rewrite
base: dev
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,24 @@ | ||
# 3DS/2DS Family | ||
|
||
<div class="tip red"> | ||
<strong>CAUTION:</strong> | ||
SYSTEM TRANSFERS ARE NOT CURRENTLY SUPPORTED BY OUR SERVERS. ATTEMPTING TO PERFORM A SYSTEM TRANSFER MAY PREVENT YOU FROM BEING ABLE TO GO ONLINE IN THE FUTURE. SUPPORT FOR SYSTEM TRANSFERS IS IN DEVELOPMENT. | ||
</div> | ||
## Things to know before you start | ||
|
||
<div class="tip red"> | ||
<strong>CAUTION:</strong> | ||
Collecting badges in Nintendo Badge Arcade while connected to one network and then launching the game on a different network will result in your badges disappearing. This occurs because the locally saved data does not match the data stored on the server. | ||
</div> | ||
This guide assumes that you have a **Homebrewed System** running the latest version of Luma3DS (13+). If you are unsure or do not have a homebrewed system, please follow the [3DS Hacks Guide](https://3ds.hacks.guide/) to check, install and update it. | ||
|
||
<div class="tip"> | ||
ℹ️ This guide assumes that you have a <b>Homebrewed System running the latest version of Luma3DS (13+)</b>, if you don't please follow this <a href="https://3ds.hacks.guide/" target="_blank">guide</a> on how to homebrew your system first. | ||
</div> | ||
Comment on lines
-13
to
-15
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Removing this as a callout makes it inconsistent with the Wii U guide There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm fine with whichever. Will make the change in a bit if necessary! |
||
**Support for system transfer is currently in development**. Attempting to perform one while being connected to Pretendo will prevent you from being able to go online in the future. If you need to do a system transfer, please do it before continuing with this guide. | ||
|
||
Badges in **Nintendo Badge Arcade** might disappear and become de-synchronized when switching between Pretendo and Nintendo Network. This is due to your local data not matching the data stored on the respective server. | ||
|
||
## Getting Started | ||
|
||
To connect to the Pretendo Network, you will need to install a homebrew application and enable Luma patches on your console. | ||
|
||
Nimbus is our homebrew application that allows you to connect and switch from Nintendo Network to the Pretendo Network. | ||
|
||
The following steps are required for you to connect to the Pretendo Network: | ||
This guide is divided into the following steps: | ||
1. [Downloading Nimbus](#downloading-nimbus) | ||
2. [Enabling Luma patches](#luma-patches) | ||
3. [Nimbus](#using-nimbus) | ||
3. [Using Nimbus](#using-nimbus) | ||
4. [Signing into your PNID](#signing-into-your-pnid) | ||
|
||
## Downloading Nimbus | ||
|
||
|
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.
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.
I'm not sure I agree with removing the caution callouts. This was done intentionally to be eye grabbing and bring attention to the information inside. These are pretty important things to know about, and having them just look like the rest of the page makes it more likely someone will skim over them
@hauntii @gitlimes @DaniElectra thoughts?
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.
Yeah I disagree with inlining the cautions and tips, I think how they are rn it's already fine
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.
I would argue that having 2 back-to-back callouts in the beginning of the guide is almost too much. A person who just wants to get Pretendo installed might ignore the callouts and skip straight to the body of the guide.
I think that having a "Prerequisites" section would be better as it is the first thing that they will read anyway.
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.
Having callouts for important information at the start of guides/wikis is fairly standard practice. You can see this on wikis like Wikipedia and even the official homebrew guide. It's done this way for a reason, to be immediately eye catching to the user. Putting key information like this as plain text like anything else definitely runs more of a risk of people missing it. Yes, people can still skip callouts. But it's far less likely
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.
And even in instances where it's not at the top of the page, important information is still typically shown in callouts within the body. You can again see this on the official homebrew guide