-
Notifications
You must be signed in to change notification settings - Fork 120
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
Create a getting started page in the documentation that we can easily reference. #372
Comments
I'll work on this one too. But honestly, I’m not quite sure what the content on this page is supposed to be. We already have detailed pages for |
From @asengupta the note they had in their Figma was:
If you notice, these are all "Possible solutions". The general idea of the Getting Started page was so that it was a single page, that community could link to, and that provided links. But I think you have done that within the Download thank you page, where we might instead have a Getting Started page replacing Introduction in the User Manual, that has links or card items. My proposal would be to rename "Introduction" as "Getting Started", and then change the paragraph style with tons of links that are easily missed, into nice cards that cover those areas above. If you notice now, our Introduction page actually has all of that and many more links, but it takes a keen eye to read and scan and then click on all those links. I think we can simplify the Introduction page, and make it much less wordy. Just one simple example, a card item for "Troubleshooting", instead of a long sentence and link within it. Generally, the Introduction was seen as beneficial when it was first created, but I think the reality is that it can only be beneficial if easily scanned through, like with card items, instead of long wordy sentences. |
Also, I would not even consider an outline as being important in the Getting Started page. Currently, the Introduction page reads through like an outline, but it's entirely not needed in my opinion. We already have an outline, inherent in the hierarchical sidebars that Docusaurus generates. |
I completely agree with @thadguidry's suggestions. Proposed Changes:
Additional Suggestions:
|
@magdmartin and others, Your thoughts on @ViragJain3010 suggestions? |
I'll be able to check this in more detail after Jan 6. |
This issue follows the Heuristic Analysis done by asengupta on the forum
Create a getting started page in the documentation that we can easily reference. That page will contain the same information as the updated post-download page (see #371) and can be used by trainers or support personnel as an entry point for new users.
The text was updated successfully, but these errors were encountered: