Skip to content

Link to "popular documentation tools" #601

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

Closed
wants to merge 1 commit into from

Conversation

humitos
Copy link
Member

@humitos humitos commented May 26, 2025

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

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 requested a review from a team as a code owner May 26, 2025 11:25
@humitos humitos requested a review from agjohnson May 26, 2025 11:25
@@ -24,7 +24,7 @@
{% trans "You don't have any projects configured yet" %}
{% endblock list_placeholder_header_empty %}
{% block list_placeholder_text_empty %}
<a href="https://docs.readthedocs.io/page/tutorial/"
<a href="https://docs.readthedocs.com/platform/stable/intro/doctools.html"
Copy link
Contributor

Choose a reason for hiding this comment

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

The list of doc tools doesn't feel like a good place to drop a user that doesn't know how to create a project. I'd leave this link to our tutorial.

I'd like to see our tutorial have some updates to mention other tools.

Copy link
Member Author

Choose a reason for hiding this comment

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

The tutorial doesn't communicate what we want to communicate, tho.

  • It seems we only support Sphinx
  • It mentions "Community" in the first paragraph
  • All the screenshots are from the old dashboard
  • It's a +30 minutes page --which is a lot of time for a first approach to the platform

I understand that the goal is to improve the tutorial, but we are far from there. We can give a better experience to our users in the meanwhile pointing them to the documentation tools, in my opinion. The user will know what tools we support and they can copy and paste working examples from there.

We can link to the tutorial from the documentation tools if we want to.

Copy link
Contributor

Choose a reason for hiding this comment

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

That page needs updates but that doesn't imply we should stop linking to it. It's serving a purpose and does a job that other pages aren't. I disagree the list of tools is a better experience for a user that doesn't know how to add a project.

I think we link to the page you want in addition, but the list of tools is not a place I would point a user asking how to add a project or use RTD.

@humitos humitos closed this May 29, 2025
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.

Onboarding: point "Learn how to get started" link to something more digestable
2 participants