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

Add JupyterLab product focused guide #553

Open
wants to merge 12 commits into
base: main
Choose a base branch
from

Conversation

jimbobbennett
Copy link
Contributor

#544

This change has product-first docs for JupyterLab. This includes a Quickstart, feature list, how to guides, and trouble shooting.

This PR also includes some changes outside of this documentation set:

  • Spelling fixes
  • Inclusive language updates
  • Adding a spell checker extension recommendation

Copy link

vercel bot commented Aug 21, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
documentation ✅ Ready (Inspect) Visit Preview Aug 30, 2024 9:46pm

Copy link
Contributor

@shivaypiece shivaypiece left a comment

Choose a reason for hiding this comment

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

Rest of it looks great!


1. Once installed, refresh the page in your browser.

### Step 2: Use the Pieces JupyterLab Extension
Copy link
Collaborator

Choose a reason for hiding this comment

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

So on the other guides we have a very simple step here that shows them how to do one thing. I think it's probably better to keep this as a simple last step of the quickstart and then they can dive into the features. What do you think?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If the goal is for the reader to ready to use the product, I personally think it is better to show a real world use case.
The 2 things we measure for usage are saving snippets, and copilot chats - so this aligns with driving those 2 behaviors from our users.

These are still simple steps, but quickly shows the 2 main use cases. They can then dive in further for more details.

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.

3 participants