Improve UX in Getting Started (+ landing page nitpick)

[guilherssousa]

Getting Started sections on documentation should be really straightforward on the app's onboarding process. Let's take a look at the current Getting Started page and propose some improvements to user navigation experience.

Group all installation methods on a single one called Installing Inkdrop, where the body would have a new ordered list, now displaying the platform-specific contents:

Optimally, in a linear flow, there are 4 actions that users perform that needs to be documented in this page: Creating your Inkdrop account, Downloading, Installing and Log In.

Currently, thanks to the orderered list, the content may be read as a step-by-step documentation on how to start using Inkdrop, but there are more information being displayed than these just 4 main steps, so a proposed solution would be:

1. [Creating your Inkdrop account](https://docs.inkdrop.app/manual/#creating-your-inkdrop-account)

2. [Downloading the app](https://docs.inkdrop.app/manual/#downloading-the-app)

3. [Installing Inkdrop](https://docs.inkdrop.app/manual/#installing)

4. [Log in](https://docs.inkdrop.app/manual/#log-in)

Then, a new Installing section, referencing to the platform-specific installation guides and also referencing to mobile versions, which are not mentioned on the documentation entrypoint (author may have a reason for not mentioning this one here, maybe it's because documentations are mostly visited via Desktop environments? valid criticisim to my issue)

Following other documentation patterns, content should be immediately after section title:

Currently, short-description related to Getting Started introduction is being displayed after the summary links. On most documentations, sections are composed by its titles and descriptions coming immediately after it. Thanks to the description nature of being a welcoming message for the user, the new ones who aren't familiarized will still read it and enjoy the warm message, but hard users who are more interested in the actual content will ignore it, instead of being baited to read thanks to a uncommon nature.

Additional Nitpicking: Docs aren't receiving enough attention on Inkdrop's landing page

Developers like to read documentation when they need to learn something new. So, it's expected from products targeting this audience to showcase links to it's documentation on a most optimal position possible.

Although Inkdrop is a developer targeted product, documentations are kind of "Hidden" (compared to other products targeting the same audience), having to hover on a toggle menu:

So, by including the Docs link at the navbar root level, it would get more traction to documentation proccess, therefore more users can discover more about the application ecosystem without having to leave the page and googling the docs.

Some examples below on other developer-targeted products:

1. React Email

2. Insomnia Client

3. Railway

[craftzdog]

@dmitriyrotaenko what do you think?

Regarding the navbar on the website, I've updated it. Check out: inkdropapp/top@69c45c2
Thanks

[guilherssousa]

Actually, after reading the suggestion with empty head, I'm reconsidering the table of contents format:
It does make sense to display the platform specific links on ToC but still they shouldn't take "extra steps" on the listing, like the image below 👇🏻

[dmitriyrotaenko]

Cool, the more accessible links to docs are, the better. Agree, with Guilherme Sousa on making platform-based steps as a nested bulleted list. I also wonder whether it's possible to display TOC to a certain depth. Like up to heading of lvl 3.

…

On Mon, 27 Feb 2023 at 14:33, Guilherme Sousa ***@***.***> wrote: Actually, after reading the suggestion with empty head, I'm reconsidering the table of contents format: It does make sense to display the platform specific links on ToC but still they shouldn't take "extra steps" on the listing, like the image below 👇🏻 [image: image] <https://user-images.githubusercontent.com/47110995/221552693-b94fe280-0ff2-4e51-8a5c-b447d347554e.png> — Reply to this email directly, view it on GitHub <https://github.com/inkdropapp/docs/issues/63#issuecomment-1446171516>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AMRO6PIOMSTDLCOP2BPBYIDWZSGHVANCNFSM6AAAAAAVGMTGJE> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[craftzdog]

While I agree with your suggestions, I would not like to spend tweaking the current Gatsby-based docs since we will be migrating to Docusaurus this year.
Let's focus on improving the content for now.