docs: Rename "user/developer guide" to "user/developer docs" to differentiate them from the guides they contain.

README.md

@@ -99,16 +99,16 @@ If you would like a feature or want to report a bug, please file an issue and we
 [badge-discord]: https://img.shields.io/discord/1377353873068392580?style=flat&logo=discord&logoColor=white&label=Discord&labelColor=%235561f5
 [badge-zulip]: https://img.shields.io/badge/Zulip-yscope--clp-1888FA?logo=zulip
 [bug-report]: https://github.com/y-scope/clp/issues/new?assignees=&labels=bug&template=bug-report.yml
-[build-package]: http://docs.yscope.com/clp/main/dev-guide/building-package
+[build-package]: http://docs.yscope.com/clp/main/dev-docs/building-package
 [clp-docs]: https://docs.yscope.com/clp/main
 [clp-ffi-go]: https://github.com/y-scope/clp-ffi-go
 [clp-ffi-py]: https://github.com/y-scope/clp-ffi-py
 [clp-loglib-py]: https://github.com/y-scope/clp-loglib-py
 [clp-paper-21]: https://www.usenix.org/system/files/osdi21-rodrigues.pdf
-[clp-paper-24]: https://www.usenix.org/system/files/osdi24-wang-rui.pdf 
-[core]: http://docs.yscope.com/clp/main/dev-guide/components-core
-[core-container]: http://docs.yscope.com/clp/main/user-guide/core-container
-[datasets]: https://docs.yscope.com/clp/main/user-guide/resources-datasets
+[clp-paper-24]: https://www.usenix.org/system/files/osdi24-wang-rui.pdf
+[core]: http://docs.yscope.com/clp/main/dev-docs/components-core
+[core-container]: http://docs.yscope.com/clp/main/user-docs/core-container
+[datasets]: https://docs.yscope.com/clp/main/user-docs/resources-datasets
 [feature-req]: https://github.com/y-scope/clp/issues/new?assignees=&labels=enhancement&template=feature-request.yml
 [log-surgeon]: https://github.com/y-scope/log-surgeon
 [log-viewer]: https://github.com/y-scope/yscope-log-viewer

components/clp-py-utils/clp_py_utils/clp_metadata_db_utils.py

@@ -133,7 +133,7 @@ def create_datasets_table(db_cursor, table_prefix: str) -> None:
     """
 
     # For a description of the table, see
-    # `../../../docs/src/dev-guide/design-metadata-db.md`
+    # `../../../docs/src/dev-docs/design-metadata-db.md`
     db_cursor.execute(
         f"""
         CREATE TABLE IF NOT EXISTS `{get_datasets_table_name(table_prefix)}` (

components/core/README.md

@@ -4,5 +4,5 @@ CLP core is the low-level component that performs compression, decompression, an
 
 See the docs below for more details:
 
-* [Building](https://docs.yscope.com/clp/main/dev-guide/components-core)
-* [Running](https://docs.yscope.com/clp/main/user-guide/core-overview)
+* [Building](https://docs.yscope.com/clp/main/dev-docs/components-core)
+* [Running](https://docs.yscope.com/clp/main/user-docs/core-overview)

components/core/src/clp/ffi/search/CompositeWildcardToken.cpp

@@ -139,7 +139,7 @@ bool CompositeWildcardToken<encoded_variable_t>::generate_next_interpretation()
  *   into two tokens at the delimiter.
  * - Finally, if a WildcardToken is delimited by a '*'-delimiter-wildcard, then the '*' should be
  *   included in the WildcardToken (see the generalization in
- *   <docs>/dev-guide/design-parsing-wildcard-queries).
+ *   <docs>/dev-docs/design-parsing-wildcard-queries).
  *
  * Algorithm:
  * - To implement this algorithm, we need to search the CompositeWildcardToken for every substring

components/core/src/glt/ffi/search/CompositeWildcardToken.cpp

@@ -139,7 +139,7 @@ bool CompositeWildcardToken<encoded_variable_t>::generate_next_interpretation()
  *   into two tokens at the delimiter.
  * - Finally, if a WildcardToken is delimited by a '*'-delimiter-wildcard, then the '*' should be
  *   included in the WildcardToken (see the generalization in
- *   <docs>/dev-guide/design-parsing-wildcard-queries).
+ *   <docs>/dev-docs/design-parsing-wildcard-queries).
  *
  * Algorithm:
  * - To implement this algorithm, we need to search the CompositeWildcardToken for every substring

components/package-template/src/README.md

@@ -5,4 +5,4 @@ compressed data without decompression. CLP's compression ratio is significantly
 general-purpose compressors like gzip.
 
 For setup and usage instructions, see
-https://docs.yscope.com/clp/main/user-guide/quick-start-overview
+https://docs.yscope.com/clp/main/user-docs/quick-start-overview

components/webui/README.md

@@ -4,4 +4,4 @@ The web interface for the CLP package.
 
 See the [docs] for more details.
 
-[docs]: https://docs.yscope.com/clp/main/dev-guide/components-webui
+[docs]: https://docs.yscope.com/clp/main/dev-docs/components-webui

docs/src/dev-guide/design-kv-ir-streams/background.md → docs/src/dev-docs/design-kv-ir-streams/background.md

@@ -11,7 +11,7 @@ We discuss each below.
 
 ## clp-s compression
 
-At a high-level, [clp-s](../../user-guide/core-clp-s.md) compresses log events into what we call
+At a high-level, [clp-s](../../user-docs/core-clp-s.md) compresses log events into what we call
 archives. Depending on the configured size-threshold for each archive, a set of log events may be
 compressed into one or more archives. The archive format is designed so that each archive is
 self-contained and independent, allowing archives to be searched concurrently.
@@ -318,7 +318,7 @@ the archive is complete.
 
 ## Parsing & encoding unstructured text
 
-clp-s uses [clp](../../user-guide/core-unstructured/clp.md)'s algorithm to parse and encode
+clp-s uses [clp](../../user-docs/core-unstructured/clp.md)'s algorithm to parse and encode
 unstructured text. Unstructured text is a string that contains zero or more variable values
 interspersed with non-variable (static) text. For example, in [Figure 1](#figure-1), log event
 #1's `message` value is unstructured text containing the variable values `task_1` and `2`. At a

docs/src/dev-guide/index.md → docs/src/dev-docs/index.md

@@ -1,6 +1,6 @@
-# Developer guide
+# Developer docs
 
-This guide contains docs useful for developing CLP. Use the left sidebar (if it's hidden, click the
+These docs are useful for developing CLP. Use the left sidebar (if it's hidden, click the
 <i class="fa fa-bars"></i> icon) to navigate to specific docs.
 
 The sections are as follows:

docs/src/index.md

@@ -71,21 +71,21 @@ features:
 
 # Getting started
 
-Check out the relevant guide below, based on whether you'd like to use or develop CLP.
+Check out the relevant docs below, based on whether you'd like to use or develop CLP.
 
 ::::{grid} 1 1 2 2
 :gutter: 2
 
 :::{grid-item-card}
-:link: user-guide/index
-User guide
+:link: user-docs/index
+User docs
 ^^^
 Docs for those interested in using and operating CLP.
 :::
 
 :::{grid-item-card}
-:link: dev-guide/index
-Developer guide
+:link: dev-docs/index
+Developer docs
 ^^^
 Docs for those interested in developing CLP.
 :::
@@ -107,8 +107,8 @@ Need help? Join us on one of our community servers:
 :::{toctree}
 :hidden:
 
-user-guide/index
-dev-guide/index
+user-docs/index
+dev-docs/index
 :::
 
 [badge-discord]: https://img.shields.io/discord/1377353873068392580?style=flat&logo=discord&logoColor=white&label=Discord&labelColor=%235561f5
@@ -118,7 +118,7 @@ dev-guide/index
 [clp-ffi-py]: https://github.com/y-scope/clp-ffi-py
 [clp-loglib-py]: https://github.com/y-scope/clp-loglib-py
 [clp-paper]: https://www.usenix.org/system/files/osdi21-rodrigues.pdf
-[datasets]: user-guide/resources-datasets
+[datasets]: user-docs/resources-datasets
 [feature-req]: https://github.com/y-scope/clp/issues/new?assignees=&labels=enhancement&template=feature-request.yml
 [log-surgeon]: https://github.com/y-scope/log-surgeon
 [log-viewer]: https://github.com/y-scope/yscope-log-viewer

docs/src/user-guide/core-overview.md → docs/src/user-docs/core-overview.md

@@ -3,7 +3,7 @@
 CLP's core component contains the core code to compress, decompress, and search compressed logs. You
 can use it to try CLP on your logs before deploying a cluster.
 
-There are currently two flavours of CLP, depending on the format of your logs. The guides below
+There are currently two flavours of CLP, depending on the format of your logs. The docs below
 explain how to use each flavour.
 
 ::::{grid} 1 1 2 2

docs/src/user-guide/index.md → docs/src/user-docs/index.md

@@ -1,6 +1,6 @@
-# User guide
+# User docs
 
-This guide documents how to use and operate CLP. Use the left sidebar (if it's hidden, click the
+These docs explain how to use and operate CLP. Use the left sidebar (if it's hidden, click the
 <i class="fa fa-bars"></i> icon) to navigate to specific docs.
 
 The sections are as follows: