-
-
Notifications
You must be signed in to change notification settings - Fork 13
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
[developer] Installation instructions are difficult to find #115
Comments
This got a bit buried because of the rework of the manual structuring 🤔
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. @HexaField What do you think we should do with the advanced installation instructions? |
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. |
It really should be as immediate and obvious as possible |
@HexaField Where should they be located specifically? |
What if we had another whole section, "Installation", "Manual", "Developer" are whole pages essentially |
What about placing it at the root level of the Manual, right next to the other sections? |
i think it's important enough and going to be asked so many times that we should put it in the nav |
"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. |
Completed the PR, but marked it as I fully believe that having a Lets solve the Discord discussion before merging this in |
@DanielBelmes The PR should be ready to review/publish with the new changes: |
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.
The text was updated successfully, but these errors were encountered: