refactor(docs): Centralize hardcoded documentation path variables into the root taskfile (fixes #1791).

[junhaoliao]

Description

Centralize the hardcoded documentation path variables (G_DOCS_SRC_DIR, G_DOCS_SRC_STATIC_DIR,
G_DOCS_SRC_STATIC_GENERATED_DIR) from taskfiles/codegen.yaml into the root taskfile.yaml so
they are globally available to all included taskfiles.

Checklist

• The PR satisfies the contribution guidelines.
• This is a breaking change and that has been indicated in the PR title, OR this isn't a
  breaking change.
• Necessary docs have been updated, OR no docs need to be updated.

Validation performed

Validation performed

0. Build docs

Task: Verify the docs build successfully with the centralized path variables in
taskfiles/docs.yaml.

Command:

task docs:site

Output:

...
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded.

The HTML pages are in ../build/docs/html.

Docs build completed with no errors or warnings, confirming G_DOCS_DIR and G_DOCS_SRC_DIR are
correctly resolved.

1. Run OpenAPI codegen

Task: Verify the OpenAPI codegen task still works with the centralized variables from
taskfiles/codegen.yaml.

Command:

task codegen:openapi

Output:

task: [codegen:openapi] . "/home/junhao/workspace/clp/build/toolchains/rust/env"
cargo run --bin api-server-openapi-codegen --release \
  -- "/home/junhao/workspace/clp/docs/src/_static/generated/api-server-openapi.json"
cargo run --bin log-ingestor-openapi-codegen --release \
  -- "/home/junhao/workspace/clp/docs/src/_static/generated/log-ingestor-openapi.json"
    Finished `release` profile [optimized] target(s) in 0.10s
     Running `build/rust-targets/release/api-server-openapi-codegen /home/junhao/workspace/clp/docs/src/_static/generated/api-server-openapi.json`
    Finished `release` profile [optimized] target(s) in 0.10s
     Running `build/rust-targets/release/log-ingestor-openapi-codegen /home/junhao/workspace/clp/docs/src/_static/generated/log-ingestor-openapi.json`

Explanation: The codegen task correctly resolves G_DOCS_SRC_STATIC_GENERATED_DIR to
docs/src/_static/generated/, confirming the centralized variables work across both
codegen.yaml and docs.yaml.

2. Build CLP package

Task: Verify the full CLP build (which includes codegen) still works.

Command:

task

Output:

...
task: [package] echo '0.8.1-dev' > '/home/junhao/workspace/clp/build/clp-package/VERSION'

Build completed successfully.

Summary by CodeRabbit

• Chores
  • Reorganized documentation build configuration variables for improved consistency and maintainability across build workflows.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

The pull request consolidates documentation path variables from taskfiles/codegen.yaml into the main taskfile.yaml, then updates taskfiles/docs.yaml to reference these centralized variables instead of local definitions.

Changes

Cohort / File(s)	Summary
Central Variable Definitions taskfile.yaml	Introduces four documentation path variables (G_DOCS_DIR, G_DOCS_SRC_DIR, G_DOCS_SRC_STATIC_DIR, G_DOCS_SRC_STATIC_GENERATED_DIR) in the main taskfile for centralised reference.
Variable Usage Updates taskfiles/docs.yaml, taskfiles/codegen.yaml	Updates docs.yaml site task to reference centralised variables; removes three variables from codegen.yaml that are now defined in the main taskfile.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related issues

• Refactor: Centralize hardcoded documentation paths in task files #1791: Directly addresses the consolidation of documentation path variables (G_DOCS_DIR, G_DOCS_SRC_DIR, G_DOCS_SRC_STATIC_DIR, G_DOCS_SRC_STATIC_GENERATED_DIR) from multiple taskfiles into the main configuration file.

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main change: centralizing documentation path variables from taskfiles/codegen.yaml into the root taskfile.yaml for global availability.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}