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

Jump to bottom

Docs: Relabel SEO guide as explanation (Diátaxis) #10004

Merged
merged 7 commits into from
Feb 10, 2023
Merged

Docs: Relabel SEO guide as explanation (Diátaxis) #10004

merged 7 commits into from
Feb 10, 2023

Conversation

benjaoming
Copy link
Contributor

@benjaoming benjaoming commented Feb 8, 2023 •
edited by github-actions bot
Loading

This is mainly documentation. The examples in here aren't really how-tos, they are still just examples.

I also put Sphinx and MkDocs examples in tabs and removed the introduction that framed this as "Sphinx-specific".

Refs: #9746

📚 Documentation previews 📚

@benjaoming benjaoming added Improvement Minor improvement to code Needed: documentation Documentation is required labels Feb 8, 2023
@benjaoming benjaoming requested a review from a team as a code owner February 8, 2023 13:54
@benjaoming benjaoming mentioned this pull request Feb 8, 2023
Closed
38 tasks
ericholscher
ericholscher reviewed Feb 9, 2023
View reviewed changes
Copy link
Member

@ericholscher ericholscher left a comment •
edited
Loading

Choose a reason for hiding this comment

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

This is close, and I really liked the additional of Mkdocs content, but wasn't sure on a couple of them. Should we also include a tab for other tools with generic advance? 🤔 Definitely not required to ship this though, maybe just a TODO?

docs/user/glossary.rst Outdated Show resolved Hide resolved
docs/user/guides/technical-docs-seo-guide.rst Show resolved Hide resolved
docs/user/guides/technical-docs-seo-guide.rst Show resolved Hide resolved
docs/user/guides/technical-docs-seo-guide.rst Outdated Show resolved Hide resolved
docs/user/guides/technical-docs-seo-guide.rst Outdated Show resolved Hide resolved
docs/user/guides/technical-docs-seo-guide.rst Outdated Show resolved Hide resolved
docs/user/guides/technical-docs-seo-guide.rst Outdated Show resolved Hide resolved
docs/user/guides/technical-docs-seo-guide.rst Show resolved Hide resolved
ericholscher
ericholscher approved these changes Feb 9, 2023
View reviewed changes
Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

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

🚢

docs/user/glossary.rst Outdated Show resolved Hide resolved
docs/user/guides/technical-docs-seo-guide.rst Outdated Show resolved Hide resolved
docs/user/guides/technical-docs-seo-guide.rst Outdated Show resolved Hide resolved
docs/user/guides/technical-docs-seo-guide.rst Outdated Show resolved Hide resolved
docs/user/guides/technical-docs-seo-guide.rst
unless the warning is silenced with the :ref:`orphan directive <sphinx:metadata>`:
Search engine crawlers will not discover pages that aren't referenced.

.. TODO: Create a "generic" tab?
Copy link
Member

Choose a reason for hiding this comment

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

💯

@benjaoming benjaoming merged commit 83a294e into readthedocs:diataxis/main Feb 10, 2023
@benjaoming benjaoming deleted the diataxis/seo-guide branch February 10, 2023 13:33
@ericholscher ericholscher mentioned this pull request Feb 14, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ericholscher ericholscher ericholscher approved these changes

Assignees

@benjaoming benjaoming

Labels
Improvement Minor improvement to code Needed: documentation Documentation is required
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@benjaoming @ericholscher