search

EtherealEngine / etherealengine-docs

Ethereal Engine Documentation
Other
6 stars 12 forks source link

[developer] Installation instructions are difficult to find #115

Closed DanielBelmes closed 7 months ago

DanielBelmes commented 7 months ago

Installation instructions are three clicks into Modules. There's no intuitive way to find them. We should either make it a top level category as it's very important. Or we should link it on the index.

heysokam commented 7 months ago

This got a bit buried because of the rework of the manual structuring :thinking:

But the problem currently exists because the microsites are closed (and the website is currently in alpha state of what it will become), and the typescript microsite is what should contain those intuitive installation instructions that are so desperately needed, and will also link to the proper section of the manual without having to go click 3 menus to find the instructions buried in the Infrastructure Module.

Also important to note is that new idea for the manual is not to be a first-entry point of information, but rather a source of reference for people who already know their way around the engine and just need the advanced details and information. That, or to be linked to a different section and/or be searched for with the searchbar.

I'm currently working on the typescript tutorial, which has the new oneliner installation for ubuntu, but it was agreed that the Control Center will solve this problem eventually, and the instructions would need to be reworked. _Relevant file: ubuntu installation that also links to those manual pages_

@HexaField What do you think we should do with the advanced installation instructions? Should we keep them as they are, or move them out of where we put them like @DanielBelmes is mentioning?

DanielBelmes commented 7 months ago

Yup that's alright but we have many people coming to the documentation to look for installation instructions and it has to be visible. It doesn't have to be in the Manual. But for now we should prioritize exposing them in the meantime as we've already had complaints on our discord help channels.

HexaField commented 7 months ago

It really should be as immediate and obvious as possible

heysokam commented 7 months ago

@HexaField Where should they be located specifically? I relied on your design/opinion for the structure of the manual, so I'm not quite sure myself on where it fits well enough for the structure redesign but also to solve this issue.

HexaField commented 7 months ago

@HexaField Where should they be located specifically? I relied on your design/opinion for the structure of the manual, so I'm not quite sure myself on where it fits well enough for the structure redesign but also to solve this issue.

What if we had another whole section, "Installation", "Manual", "Developer" are whole pages essentially

heysokam commented 7 months ago

@HexaField Where should they be located specifically? I relied on your design/opinion for the structure of the manual, so I'm not quite sure myself on where it fits well enough for the structure redesign but also to solve this issue.

What if we had another whole section, "Installation", "Manual", "Developer" are whole pages essentially

image Relevant, as it shows the look of the final navbar I feel like that would clutter the navbar a lot, which is already quite complex (in the final version, not the one currently exposed) and derail from the Personas site idea a bit :thinking:

What about placing it at the root level of the Manual, right next to the other sections? Maybe even the first one before Concepts, if its so important to warrant a whole micro-site? :thinking:

HexaField commented 7 months ago

i think it's important enough and going to be asked so many times that we should put it in the nav

heysokam commented 7 months ago

"It's in the manual" and then you find it right there at the top first option sounds intuitive to me, and at the same time doesn't worsen the navbar UX. But will do that :writing_hand:

heysokam commented 7 months ago

Completed the PR, but marked it as Draft as I don't think this is creating good UX https://github.com/EtherealEngine/etherealengine-docs/pull/116#issuecomment-1934974790

I fully believe that having a /manual/install section, positioned right above Concepts, and exposing that route to the navbar while the microsites are WIP, is a much better solution to not break the UX that was created with the Personas strategy... than it is to have a full installation microsite.

Lets solve the Discord discussion before merging this in

heysokam commented 7 months ago

@DanielBelmes The PR should be ready to review/publish with the new changes: https://github.com/EtherealEngine/etherealengine-docs/pull/116#issuecomment-1936593736