Skip to content

docs: add user guide with a job-configuration reference - #1026

Open
matclim wants to merge 1 commit into
Framework-R-D:mainfrom
matclim:docs/user-guide-configuration
Open

matclim wants to merge 1 commit into
Framework-R-D:mainfrom
matclim:docs/user-guide-configuration

Conversation

@matclim

@matclim matclim commented Nov 1, 2026

Copy link
Copy Markdown
Contributor

The Sphinx site only documents a few proxy classes. Add a "User guide" section and a first page that describes what the framework itself reads from a job configuration:

  • the phlex command-line options and how they override the file
  • the top-level keys (stage, max_concurrency, driver, sources, modules, resources), and that unknown keys are silently ignored
  • plugin entries: cpp/py, the injected module_label, PHLEX_PLUGIN_PATH lookup, RTLD_LOCAL loading, and the plugin load order
  • the driver entry, uses_sources and the generate_layers parameters
  • SPDLOG_LEVEL and the default-logger restore
  • passing Jsonnet top-level arguments via the jsonnet tool

The new toctree globs guide/*, so later guide pages only need to add a file.

Assisted by: Claude Haiku 5.5

The Sphinx site only documents a few proxy classes.  Add a "User guide"
section and a first page that describes what the framework itself reads
from a job configuration:

- the phlex command-line options and how they override the file
- the top-level keys (stage, max_concurrency, driver, sources, modules,
  resources), and that unknown keys are silently ignored
- plugin entries: cpp/py, the injected module_label, PHLEX_PLUGIN_PATH
  lookup, RTLD_LOCAL loading, and the plugin load order
- the driver entry, uses_sources and the generate_layers parameters
- SPDLOG_LEVEL and the default-logger restore
- passing Jsonnet top-level arguments via the jsonnet tool

The new toctree globs guide/*, so later guide pages only need to add a
file.

Assisted by: Claude Haiku 5.5
@coderabbitai

coderabbitai Bot commented Nov 1, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 58 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: ed52793a-ca00-449f-9e64-3779d8550a90
Commits

Reviewing files that changed from the base of the PR and between ce771e1 and 5bcf79d.

Files selected for processing: 2
  • docs/source/guide/configuration.rst
  • docs/source/index.rst
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

@matclim

matclim commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor Author

To clarify since Copilot made a suggestion on #1030
This PR adds the User guide toctree that the other doc PRs (#1025, #1028–#1031) rely on. Since #1024 has merged, main now has guide/product_selectors.rst outside any toctree, which was warned about. This PR includes it via guide/* and still merges cleanly, so it would be good to merge before the others, if possible.

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