Docs improvement - Apply suggestions from code review

Co-authored-by: kirkrodrigues <[email protected]>
y-scope · Nov 25, 2024 · a70caee · a70caee
1 parent e5ff524
commit a70caee
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 5 deletions.
diff --git a/Taskfile.yaml b/Taskfile.yaml
@@ -5,7 +5,6 @@ includes:
   utils: "tools/yscope-dev-utils/taskfiles/utils.yml"
 
 vars:
-  # Build paths
   G_BUILD_DIR: "{{.ROOT_DIR}}/build"
 
 tasks:

diff --git a/docs/README.md b/docs/README.md
@@ -14,9 +14,8 @@ this project:
 * [Node.js] >= 16 to be able to [view the output](#viewing-the-output)
 * Python 3.10 or later
 * [Task] >= 3.38.0
-  * We constrain the version because, in lower versions, the Taskfile syntax we use has bugs.
 
-## Build Commands
+## Build commands
 
 * Build the site incrementally:
 
@@ -32,7 +31,7 @@ this project:
   task docs:clean
   ```
 
-## Viewing the Output
+## Viewing the output
 
 ```shell
 task docs:serve

diff --git a/docs/conf/conf.py b/docs/conf/conf.py
@@ -3,7 +3,7 @@
 
 project = "YScope Log Viewer"
 # NOTE: We don't include a period after "Inc" since the theme adds one already.
-copyright = "2021-2024 YScope Inc"
+copyright = "2022-2024 YScope Inc"
 
 # -- General configuration -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,7 +5,6 @@ includes: @@
       utils: "tools/yscope-dev-utils/taskfiles/utils.yml"
     vars:
-      # Build paths
       G_BUILD_DIR: "{{.ROOT_DIR}}/build"
     tasks:
@@ Expand Down @@