Skip to content
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

UG -> Getting Started: Make this section more user friendly #2575

Open
damithc opened this issue Oct 12, 2024 · 2 comments · May be fixed by #2589
Open

UG -> Getting Started: Make this section more user friendly #2575

damithc opened this issue Oct 12, 2024 · 2 comments · May be fixed by #2589

Comments

@damithc
Copy link
Contributor

damithc commented Oct 12, 2024

As this is the first page new users will read, we should try to make it as beginner-friendly as possible.

Suggestions:

  • This note seems a bit 'too technical' for someone just getting started with MarkBind.
    image
    Either rephrase to be friendlier, or move somewhere else?

  • We can provide more guidance on how to install npm+node etc. For example, for each OS, we can point to which page to go to and which version to install.

@lhw-1
Copy link
Contributor

lhw-1 commented Jan 15, 2025

In terms of the Node LTS Error message, we can move the bulk of the comment (and maybe a bit more details from the GitHub issue, instead of just linking the issue itself) to the "Troubleshooting" section. We can also truncate this current comment and link the "Troubleshooting" subsection on the error directly.

In terms of guidance on npm and node installation, as @damithc suggested, linking the npm and node installation pages for each of the supported OSes should be sufficient. We could even display the links in a table format (or some other component that could be used here, at the discretion of whoever wants to try tackling this issue 😄).

@seah-minlong
Copy link

For the Node LTS Error, the documentation for the warning seems to have been removed in the code following PR #2572, but the website has not been updated to reflect this change yet 😄.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants