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

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 4 additions & 3 deletions docs/user/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,10 @@ to help you create fantastic documentation for your project.
:caption: Reference
:glob:

api/index
reference/features
/api/index
/server-side-search/api
/reference/features
/server-side-search/syntax


Read the Docs feature overview
Expand Down Expand Up @@ -153,7 +155,6 @@ and some of the core features of Read the Docs.
/integrations
/versions
/hosting
/server-side-search/index
/security-log

/builds
Expand Down
1 change: 1 addition & 0 deletions docs/user/reference/features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ Features
:maxdepth: 1

analytics
/server-side-search/index
5 changes: 0 additions & 5 deletions docs/user/server-side-search/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,6 @@ If you are using :doc:`/commercial/index` you will need to replace
https://readthedocs.org/ with https://readthedocs.com/ in all the URLs used in the following examples.
Check :ref:`server-side-search/api:authentication and authorization` if you are using private versions.

.. contents:: Table of contents
:local:
:backlinks: none
:depth: 3

API V3
------

Expand Down
17 changes: 6 additions & 11 deletions docs/user/server-side-search/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,17 @@ this is powered by Elasticsearch_.
You can search all projects at https://readthedocs.org/search/,
or search only on your project from the :guilabel:`Search` tab of your project.

.. contents:: Table of contents
:local:
:backlinks: none
:depth: 3
.. seealso::

.. toctree::
:maxdepth: 2
:glob:
:hidden:

*
:doc:`/server-side-search/syntax`
Syntax options for searching Read the Docs projects
:doc:`/server-side-search/api`
Reference to the Server Side Search API

Search features
---------------

We offer a number of benefits compared to other documentation hosts:
Read the Docs has the following search features:

Search across :doc:`subprojects </subprojects>`
Subprojects allow you to host multiple discrete projects on a single domain.
Expand Down
11 changes: 3 additions & 8 deletions docs/user/server-side-search/syntax.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,9 @@
Search Query Syntax
===================

When searching on Read the Docs, you can use some parameters in your
query in order to search on given projects, versions,
or to get more accurate results.

.. contents:: Table of contents
:local:
:backlinks: none
:depth: 3
When searching on Read the Docs with :doc:`Server Side Search </server-side-search/index>`,
you can use some parameters in your query
in order to search on given projects, versions, or to get more accurate results.

Parameters
----------
Expand Down