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

Subsectioned/rewrote Description, Added Julia links to Installation #17

Merged
merged 2 commits into from
Aug 14, 2024

Conversation

sbrincat
Copy link
Collaborator

@sbrincat sbrincat commented Aug 8, 2024

Don’t want to step on anyone’s toes, but I thought the splash page could use a few changes:

  • “About/Description” felt like kind of an intimidating big wall of text. I broke it into subsections: Overview, Features, Interface, Performance, and Implementation.
  • To me, the Description felt a bit too oriented toward developers and algorithm aficionados, rather than end users. I moved all the stuff about what Julia packages NB uses under the hood to the end (Implementation section) and slightly trimmed some of the discussion of *DEs.
  • “Installation” assumed users are good to go with Julia setup, but many/most will not be. I added links to install Julia and sign up for a JuliaHub account.

Of course, I’m the new guy here, so what do I know? So feel free to take these as suggestions and undo/amend as you see fit, especially if I’ve removed or altered something anyone sees as critical.

-Reorg/minor rewrite to make description more user-oriented
-Added links to Julia install, JuliaHub to Installation
-Added note to "Installation" that GUI doesn't require Julia knowledge
-Added link to Learning Julia page to "Installation"
@sbrincat sbrincat requested a review from harisorgn August 9, 2024 21:10
@harisorgn
Copy link
Member

Thanks for the comments Scott. This looks good to me, it does make the intro page more inclusive to non-computational and non-Julian folks.

@harisorgn harisorgn merged commit 501e55c into main Aug 14, 2024
1 check failed
@harisorgn harisorgn deleted the description-rewrite branch August 29, 2024 10:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants