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.

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

Remove Sphinx/Mkdocs focus on dashboard: #545

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

Remove Sphinx/Mkdocs focus on dashboard: #545

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c762e3e
Remove Sphinx/Mkdocs focus on dashboard:
ericholscher Dec 13, 2024
8fbea78
Remove from settings form too
ericholscher Dec 13, 2024
da908d5
Put in resources
ericholscher Dec 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions readthedocsext/theme/templates/projects/base_dashboard.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,12 @@ <h2 class="ui small header">{% trans "Help topics" %}</h2>
<div class="ui mini header">{% trans "Tutorials" %}</div>
<div class="ui bulleted list">
{% include "includes/elements/link.html" with url="https://docs.readthedocs.io/page/tutorial/index.html" text="Getting started" is_external=True class="item" %}
{% include "includes/elements/link.html" with url="https://docs.readthedocs.io/page/intro/getting-started-with-sphinx.html" text="Getting started with Sphinx" is_external=True class="item" %}
{% include "includes/elements/link.html" with url="https://docs.readthedocs.io/page/intro/getting-started-with-mkdocs.html" text="Getting started with MkDocs" is_external=True class="item" %}
{% include "includes/elements/link.html" with url="https://docs.readthedocs.io/page/intro/import-guide.html" text="Creating a project" is_external=True class="item" %}
</div>

<div class="ui mini header">{% trans "Reference" %}</div>
<div class="ui bulleted list">
{% include "includes/elements/link.html" with url="https://docs.readthedocs.io/page/intro/doctools.html" text="Popular documentation tools" is_external=True class="item" %}
Copy link
Contributor

Choose a reason for hiding this comment

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

This feels like it should still be under tutorials and should retain "Getting started" in some way. "Popular documentation tools" doesn't imply these are guides on how to use these tools. "Popular documentation tools" makes sense in the TOC mostly because it's under the "Getting started" caption but that is out of context here.

{% include "includes/elements/link.html" with url="https://docs.readthedocs.io/page/config-file/index.html" text="Configuration file reference" is_external=True class="item" %}
{% include "includes/elements/link.html" with url="https://docs.readthedocs.io/page/build-customization.html" text="Build process customization" is_external=True class="item" %}
</div>
Expand Down
3 changes: 1 addition & 2 deletions readthedocsext/theme/templates/projects/settings_basics_form.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,12 +73,11 @@ <h3 class="ui small header">{% trans "Delete project" %}</h3>
<div class="ui mini header">{% trans "Tutorials" %}</div>
<div class="ui bulleted list">
{% include "includes/elements/link.html" with url="https://docs.readthedocs.io/page/tutorial/index.html" text="Getting started" is_external=True class="item" %}
{% include "includes/elements/link.html" with url="https://docs.readthedocs.io/page/intro/getting-started-with-sphinx.html" text="Getting started with Sphinx" is_external=True class="item" %}
{% include "includes/elements/link.html" with url="https://docs.readthedocs.io/page/intro/getting-started-with-mkdocs.html" text="Getting started with MkDocs" is_external=True class="item" %}
{% include "includes/elements/link.html" with url="https://docs.readthedocs.io/page/intro/import-guide.html" text="Importing your documentation" is_external=True class="item" %}
</div>
<div class="ui mini header">{% trans "Resources" %}</div>
<div class="ui bulleted list">
{% include "includes/elements/link.html" with url="https://docs.readthedocs.io/page/intro/doctools.html" text="Popular documentation tools" is_external=True class="item" %}
{% include "includes/elements/link.html" with url="https://docs.readthedocs.io/page/config-file/v2.html" text="Configuration file" is_external=True class="item" %}
{% include "includes/elements/link.html" with url="https://docs.readthedocs.io/page/guides/pull-requests.html" text="How to configure pull request builds" is_external=True class="item" %}
{% include "includes/elements/link.html" with url="https://docs.readthedocs.io/page/guides/automation-rules.html" text="How to manage versions automatically" is_external=True class="item" %}
Expand Down