Skip to content
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

Merged
merged 22 commits into from
May 8, 2024
Merged

Conversation

ISSOtm
Copy link
Member

@ISSOtm ISSOtm commented Jan 11, 2024

Also list "static bins" options where available, and clean up some wording.

Fixes #59.

@ISSOtm ISSOtm requested a review from avivace January 11, 2024 14:46
@ISSOtm
Copy link
Member Author

ISSOtm commented Jan 11, 2024

cc @rondnelson99 and @LIJI32 for review.

src/pages/install/index.md Outdated Show resolved Hide resolved
src/pages/install/index.md Outdated Show resolved Hide resolved
src/pages/install/index.md Outdated Show resolved Hide resolved
src/pages/install/linux.md Outdated Show resolved Hide resolved
src/pages/install/linux.md Outdated Show resolved Hide resolved
src/pages/install/linux.md Outdated Show resolved Hide resolved
src/pages/install/linux.md Outdated Show resolved Hide resolved
src/pages/install/linux.md Outdated Show resolved Hide resolved
src/pages/install/linux.md Outdated Show resolved Hide resolved
src/pages/install/linux.md Outdated Show resolved Hide resolved
src/pages/install/macos.md Outdated Show resolved Hide resolved
src/pages/install/macos.md Outdated Show resolved Hide resolved
src/pages/install/macos.md Outdated Show resolved Hide resolved
src/pages/install/macos.md Outdated Show resolved Hide resolved
src/pages/install/macos.md Outdated Show resolved Hide resolved
src/pages/install/macos.md Outdated Show resolved Hide resolved
src/pages/install/macos.md Outdated Show resolved Hide resolved
src/pages/install/macos.md Outdated Show resolved Hide resolved
src/pages/install/linux.md Outdated Show resolved Hide resolved
src/pages/install/linux.md Outdated Show resolved Hide resolved
src/pages/install/macos.md Outdated Show resolved Hide resolved
src/pages/install/windows.md Outdated Show resolved Hide resolved
src/pages/install/windows.md Outdated Show resolved Hide resolved
src/pages/install/windows.md Outdated Show resolved Hide resolved
src/pages/install/windows.md Outdated Show resolved Hide resolved
src/pages/install/windows.md Outdated Show resolved Hide resolved
src/pages/install/windows.md Outdated Show resolved Hide resolved
src/pages/install/windows.md Outdated Show resolved Hide resolved
src/pages/install/windows.md Outdated Show resolved Hide resolved
src/pages/install/windows.md Outdated Show resolved Hide resolved
src/pages/install/windows.md Outdated Show resolved Hide resolved
src/pages/install/macos.md Outdated Show resolved Hide resolved
src/pages/install/macos.md Outdated Show resolved Hide resolved
src/pages/install/windows.md Outdated Show resolved Hide resolved
src/pages/install/linux.md Outdated Show resolved Hide resolved
src/pages/install/macos.md Outdated Show resolved Hide resolved
ISSOtm and others added 11 commits February 18, 2024 18:16
Co-authored-by: Rangi <35663410+Rangi42@users.noreply.github.com>
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!
@ISSOtm
Copy link
Member Author

ISSOtm commented Feb 18, 2024

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
Copy link
Sponsor Member

@avivace avivace left a 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:

  1. Some pages are now a messy combination of a bunch of boxes trying to get your attention and it feels very confusing to navigate:

image

  1. 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.

  2. The Windows page is now literally 3 lines. Why are why separating pages again and require additional navigation? What is the advantage?

  3. 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".

install/linux.md Outdated Show resolved Hide resolved
install/macos.md Outdated Show resolved Hide resolved
install/linux.md Outdated Show resolved Hide resolved
install/macos.md Outdated Show resolved Hide resolved
install/source.md Outdated Show resolved Hide resolved
install/windows.md Show resolved Hide resolved
install/windows.md Show resolved Hide resolved
install/windows.md Show resolved Hide resolved
install/windows.md Outdated Show resolved Hide resolved
avivace and others added 4 commits May 7, 2024 09:14
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>
install/macos.md Outdated Show resolved Hide resolved
ISSOtm and others added 3 commits May 8, 2024 01:26
Co-authored-by: Sylvie <35663410+Rangi42@users.noreply.github.com>
@avivace avivace merged commit a18cca2 into gbdev:master May 8, 2024
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.

Improve the install instructions
6 participants