Skip to content

Docs: Relabel Server Side Search #9897

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

Conversation

benjaoming
Copy link
Contributor

@benjaoming benjaoming commented Jan 13, 2023

Relabling these articles. We should separate references and explanations and not gather them under domain-specific subtopics.

Aside from that, I kept changes minimal here as the articles went under a recent review.

Open question: Is "Server Side Search" to be understood as a proper noun? Or should we just say "server-side search"?

I removed the local TOCs as we haven been using that in many other places.

Refs: #9746


📚 Documentation previews 📚

@benjaoming benjaoming requested review from a team as code owners January 13, 2023 22:46
@benjaoming benjaoming requested a review from agjohnson January 13, 2023 22:46
@benjaoming benjaoming changed the base branch from main to diataxis/main January 13, 2023 22:46
@benjaoming
Copy link
Contributor Author

There was also a suggestion to change the title of the explanation article to "Fast server-side search" - I do think it sounds better because it puts emphasis on one of the most important aspects of switching from the built-in search of Sphinx (and MkDocs in the future?).

@benjaoming benjaoming removed request for a team and agjohnson January 13, 2023 22:48
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.

I agree the local TOC's are not great, and we should likely just have them in the theme like many other themes (eg. Furo)

@benjaoming benjaoming merged commit 18959e1 into readthedocs:diataxis/main Jan 20, 2023
@benjaoming benjaoming deleted the diataxis/relabel-server-side-search branch January 20, 2023 19:06
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.

2 participants