docs: link to docs hub fuel installation guide #1374
Conversation
|
Setting this to draft as it appears that the requisite PR for the docs hub has not been merged. |
|
Installation guide was merged 🫡 |
There was a problem hiding this comment.
@cold-briu One comment from me. Will defer to @deekerno and @lostman as well
|
|
||
| Install `fuelup` by running the following command, which downloads and runs the installation script. | ||
|
|
||
| ```bash |
There was a problem hiding this comment.
- Any reason we removed this?
- If possible, it'd be preferable to keep the user on this page (no extra clicks) if installing
fuelupis still possible in a single command.- Similarly for the "After
fueluphas been installed," bit below. Are we throwing the baby 👶🏼 out with the bath water 🛀🏼 here?
- Similarly for the "After
There was a problem hiding this comment.
To extend @ra0x3's point, the intention was to (when possible) prevent the user from having to go to another page just to come back to this one after they install fuelup. I think there's a middle ground where we include the link but also include the one-line installation command; that way, they can open it if they want more information.
There was a problem hiding this comment.
Hi there! Thanks for reviewing.
-
The main reason for this is to reduce content duplication across the entire toolchain documentation, simplifying maintenance.
-
I understand your perspective on keeping the user in the same page.
-
My take is to use mdbook code imports as seen here.
There was a problem hiding this comment.
Hi there!
In the short term, we won't take further action here since it is common that the user already have the toolchain installed by the moment they start working with the indexer.
I'll request review again, so it can be merged.
In order to remove documentation redundancy issues, the fuel installation guide is being centralized in the docs-hub.
Check docs-hub/62