Skip to content

Conversation

vmaerten
Copy link
Member

@vmaerten vmaerten commented Aug 18, 2025

  • Added flags to the config file (CLI values take precedence over config).
  • Documented the remote CLI flag (marked as experimental with a badge).
  • Documented the gentle-force CLI flag (marked as experimental with a badge).
  • Updated documentation with cross-links between CLI and config pages.

Fixes #1403

@vmaerten vmaerten marked this pull request as ready for review August 19, 2025 08:10
@vmaerten vmaerten requested review from andreynering and pd93 August 19, 2025 08:10
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Up for debate, but I'm not convinced that these flags should be documented here. I've always seen the experiments as independent from the rest of Task and fully documented within their experiments page. This means that the main docs are stable and not changing all the time.

The intention would then be to move the experiment docs to the appropriate place when released.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I get your point, but it still feels a bit odd to me that it’s in reference/config.yml but not in cli.md.
Personally, I think all the flags you see in task -h should also show up in cli.md.

Remote experiments are used a lot, and it’s not always clear which flags exist or what they actually do just from the experiment page. That’s why I suggested documenting it, but with a note like:

This flag is linked to an experiment (see XXXXX) and could be removed at any time.

That said, if you both prefer not to include it here, I’m fine with removing it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think for the config reference, I would include a section for the experiments: key, but not include the specific experiments. Just say something along the lines of "please refer to the experiments pages for more details" and then describe the name of the key and values over there.

I don't think specific experiments should be described in any pages outside the experiments docs themselves.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure what you mean but I've removed all remote and gentle force stuff from CLI.md

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it! Let me know if this is what you had in mind 🙂

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree

vmaerten and others added 4 commits August 24, 2025 18:48
@vmaerten vmaerten requested a review from pd93 August 24, 2025 17:14
@vmaerten vmaerten requested a review from pd93 August 24, 2025 17:44
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.

Feature request: All remote taskfile options in .taskrc config
3 participants