-
Notifications
You must be signed in to change notification settings - Fork 8
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
Split install instructions into separate pages #60
Conversation
cc @rondnelson99 and @LIJI32 for review. |
Co-authored-by: Rangi <35663410+Rangi42@users.noreply.github.com>
Co-authored-by: Rangi <35663410+Rangi42@users.noreply.github.com>
Co-authored-by: Sylvie <35663410+Rangi42@users.noreply.github.com>
The update pace has slowed down a lot anyway
This delineates them much better, and also allows linking to individual methods much more easily!
I see the points @avivace made in his review comment, so I have tried addressing them in the last two commits. (Plus a rebase.) I hope it's satisfactory. Now that headings are added to each sub-page, I think that it's not a good idea to re-merge everything into a single page, because then that creates a lot of headings in that single page, and I think that'd dilute their value then. In hindsight, that single sentence summarising three steps makes me feel like the original writing was kind of dumb. Oops. |
Notably, this enables a sidebar, and automatic breadcrumbs.
These are more stable, and converted+checked at compile time
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.
Thanks for the follow up @ISSOtm . This definitely looks better than before and I think we're getting there..
However:
- Some pages are now a messy combination of a bunch of boxes trying to get your attention and it feels very confusing to navigate:
-
The MacOs and the Linux manual instructions are basically identical so I don't understand why they were split in two pages. This added complexity over the one page solution we had before which is way more clearer and has less redundant information.
-
The Windows page is now literally 3 lines. Why are why separating pages again and require additional navigation? What is the advantage?
-
I like that Build RGBDS yourself and use a development version are "exposed" in the sidebar. "Building RGBDS yourself" is a strange/uncommon wording though, we should go for a more traditional "Build RGBDS" or "Compiling RGBDS".
Co-authored-by: Sylvie <35663410+Rangi42@users.noreply.github.com>
Co-authored-by: Sylvie <35663410+Rangi42@users.noreply.github.com>
Co-authored-by: Sylvie <35663410+Rangi42@users.noreply.github.com>
Co-authored-by: Sylvie <35663410+Rangi42@users.noreply.github.com>
Co-authored-by: Sylvie <35663410+Rangi42@users.noreply.github.com>
Also list "static bins" options where available, and clean up some wording.
Fixes #59.