Skip to content

Conversation

@NotTheDr01ds
Copy link
Contributor

@NotTheDr01ds NotTheDr01ds commented Dec 4, 2024

Overall, this keeps the structure of the Quick Start, with some changes:

  • Overall, I think it's more "newbie friendly", with more callouts, tips, links, etc.
  • Does away with snippets, as with other updates. All code-blocks are embedded in the page.
  • Adds Headings to make it easier to see when we jump between topics, which also ...
  • Adds a Table of Contents
  • Updates all examples to use # => on output. This allows the Copy button to be used on the code-block without attempt to "run a table" ;-)
  • Wordsmithing to try to make key concepts a bit more clear.
  • (Major) Reduces the emphasis on nested data, as that's a bit more than "Quick Start" material. I still mention nested data, with a link to the relevant section of the doc for more detail.
  • (Major) Adds a brief section on $in, with a link to the relevant doc.
  • Since this is the Quick Start, adds a bit more detail on Help, including F1 (our hidden feature).
  • (Major) Adds a quick section on explore. I think it's an under-advertised, newbie-friendly feature.

Copy link
Member

@sholderbach sholderbach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That new prose reads lovely!

@NotTheDr01ds
Copy link
Contributor Author

@sholderbach Thanks for the feedback! I've pushed the latest changes based on it.

Copy link
Member

@132ikl 132ikl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!! Much more newbie friendly 😄

@fdncred
Copy link
Contributor

fdncred commented Dec 9, 2024

ping me when this is ready and i'll land it. thanks!

@NotTheDr01ds
Copy link
Contributor Author

@fdncred Thanks! It's ready - All changes from review are in.

@NotTheDr01ds NotTheDr01ds marked this pull request as draft December 9, 2024 22:51
@NotTheDr01ds
Copy link
Contributor Author

NotTheDr01ds commented Dec 9, 2024

Ack - Found that my last change didn't save. 30 seconds ...

@fdncred Ok, now it's good.

@NotTheDr01ds NotTheDr01ds marked this pull request as ready for review December 9, 2024 22:52
@fdncred fdncred merged commit 61adb5c into nushell:main Dec 9, 2024
2 checks passed
@fdncred
Copy link
Contributor

fdncred commented Dec 9, 2024

Thanks

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.

4 participants