Skip to content

Onboarding: point "Learn how to get started" link to something more digestable #436

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.

Sign up for GitHub

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

Jump to bottom
Closed
humitos opened this issue Jul 25, 2024 · 1 comment
Closed

Onboarding: point "Learn how to get started" link to something more digestable #436

humitos opened this issue Jul 25, 2024 · 1 comment
Assignees
@humitos
Labels
Improvement Minor improvement to code Needed: design decision A core team decision is required

Comments

@humitos
Copy link
Member

humitos commented Jul 25, 2024

After the user creates an account, we show the following screen:

Screenshot_2024-07-25_18-32-56

The link "Learn how to get started" points to the tutorial, which is a lot of information for a user at this stage. It's also worth to note that the first paragraph of the tutorial says:

In this tutorial you will learn how to host a public documentation project on Read the Docs Community.

which is pretty confusing if the user created an account on Read the Docs for Business.

At Book Club we talk point them to something easier to follow and quicker to start with. Maybe a new "Quickstart with Read the Docs" guide that is tool agnostic and shows all the YAML examples we have in our "Add project" wizard.
@humitos humitos added Improvement Minor improvement to code Needed: design decision A core team decision is required labels Jul 25, 2024
@github-project-automation github-project-automation bot moved this to Planned in 📍Roadmap Jul 25, 2024
@humitos
Copy link
Member Author

humitos commented Sep 10, 2024

Once the page mentioning all the doctools is ready, we can link it to there:

humitos added a commit that referenced this issue May 26, 2025
@humitos
Link to "popular documentation tools"
e185a27 
Instead of linking to the tutorial, we are linking to the doctools.
That way, the user can immediately know there are a bunch of doctools
supported and it's not just Sphinx.

Closes #436
@humitos humitos mentioned this issue May 26, 2025
Closed
@humitos humitos self-assigned this May 26, 2025
@humitos humitos moved this from Planned to Needs review in 📍Roadmap May 26, 2025
@humitos humitos closed this as not planned Won't fix, can't repro, duplicate, stale May 29, 2025
@github-project-automation github-project-automation bot moved this from Needs review to Done in 📍Roadmap May 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@humitos humitos

Labels
Improvement Minor improvement to code Needed: design decision A core team decision is required
Projects
📍Roadmap
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Link to "popular documentation tools" readthedocs/ext-theme
1 participant
@humitos