Skip to content

Quickstart docs site improvements #182

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

Merged
merged 3 commits into from
May 7, 2024
Merged

Quickstart docs site improvements #182

merged 3 commits into from
May 7, 2024

Conversation

nrichers
Copy link
Collaborator

@nrichers nrichers commented May 5, 2024

Internal Notes for Reviewers

While working on our first QuickStart video, I realized we can speed up the user journey. Here are a couple of short videos to demo the difference:

Also includes are some minor text edits to highlight that you're learning how to document a model.

EDIT: I needed this to be live to record QuickStart videos, so don't be surprised if you look at our docs site and see the new experience already.

External Release Notes

We reworked our QuickStart experience to shorten the number of clicks it takes to get you started. You can now access the QuickStart from the home page or our docs site and we direct you to the preferred Jupyter Hub version right away. Try it ...

@nrichers nrichers added the documentation Improvements or additions to documentation label May 5, 2024
@nrichers nrichers changed the title Quickstart improvements Quickstart docs site improvements May 5, 2024
@nrichers nrichers added DO NOT MERGE PR is not ready to be merged and removed DO NOT MERGE PR is not ready to be merged labels May 6, 2024
@nrichers nrichers requested a review from validbeck May 6, 2024 14:38
Copy link
Collaborator

@validbeck validbeck left a comment

Choose a reason for hiding this comment

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

Nice! Overall I like the changes, especially having the button on the Landing Page.

Website docs link

  • We may want to change our WP website so that the documentation link takes you to the Landing instead of https://docs.validmind.ai/guide/get-started.html, as that is where it currently takes you when you click on Documentation, but I think we wanted to retool this section landing anyhow...

JupyterHub

  • We're directing users to JupyterHub instead of giving them a choice between the tools, is this because this is the lowest bar for entry?
  • I also don't see the updated notebook with the "Get your code snippet" header when I click on the link out to Jupyter after pulling down the PR and previewing with Quarto, has this not been replaced yet? (Sidenote: How does one replace that notebook? Do I have access to do that?)
Screenshot 2024-05-06 at 11 28 23 AM

EDIT: Also, I tried testing this with my personal Google account to see if it would let me access the notebook, and it doesn't — not sure if that will be an issue for users that are just curious.

Google Colab

  • We should probably think about updating the Colab notebook with the ToC as well (and get that bug about the preview of the template not working fixed: sc-4123)

@nrichers
Copy link
Collaborator Author

nrichers commented May 6, 2024

  • We may want to change our WP website so that the documentation link takes you to the Landing instead of https://docs.validmind.ai/guide/get-started.html

Yes, that would make a lot of sense since it's just a general link to our docs site. Can you follow up on that, @validbeck? We should just link to https://docs.validmind.ai/.

We're directing users to JupyterHub instead of giving them a choice between the tools, is this because this is the lowest bar for entry?

Technically, they can still choose but we've taken out the semantic load out of having to parse the the getting started and choosing.

I also don't see the updated notebook with the "Get your code snippet" header when I click on the link out to Jupyter after pulling down the PR and previewing with Quarto, has this not been replaced yet? (Sidenote: How does one replace that notebook? Do I have access to do that?)

It'll require validmind/validmind-library#71 to be merged but I am still tweaking that a bit. Deployment to Jupyter Hub involves Andres at the moment, I don't have access to that.

Copy link
Collaborator

@validbeck validbeck left a comment

Choose a reason for hiding this comment

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

Can you follow up on that, @validbeck? We should just link to https://docs.validmind.ai/.

Done!

It'll require validmind/validmind-library#71 to be merged but I am still tweaking that a bit. Deployment to Jupyter Hub involves Andres at the moment, I don't have access to that.

Makes sense, all roads lead to Rome Andres ;)

@nrichers
Copy link
Collaborator Author

nrichers commented May 7, 2024

  • We should probably think about updating the Colab notebook with the ToC as well (and get that bug about the preview of the template not working fixed: sc-4123)

I put that story into Sprint 50 with a pointer to validmind/validmind-library#71.

@nrichers nrichers merged commit abbde9e into main May 7, 2024
6 checks passed
@nrichers nrichers deleted the quickstart-improvements branch May 7, 2024 18:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants