Skip to content

docs(tasks): create dedicated monorepo tasks documentation#6561

Merged
jdx merged 3 commits intomainfrom
docs/monorepo-tasks
Oct 6, 2025
Merged

docs(tasks): create dedicated monorepo tasks documentation#6561
jdx merged 3 commits intomainfrom
docs/monorepo-tasks

Conversation

@jdx
Copy link
Copy Markdown
Owner

@jdx jdx commented Oct 6, 2025

Summary

Creates comprehensive documentation for monorepo tasks in a dedicated page and updates related documentation to reference it.

Changes

  • New documentation: docs/tasks/monorepo.md - comprehensive guide covering:

    • Overview and benefits
    • Configuration and setup
    • Task path syntax (absolute, current directory, wildcards)
    • Tool inheritance from parent configs (new feature documented)
    • Performance tuning
    • Best practices
    • Troubleshooting
  • Updated references:

    • docs/tasks/task-configuration.md - replaced full monorepo section with link to new doc
    • docs/configuration.md - added mention of tool inheritance feature and updated link

Why

The monorepo task information was embedded in the task configuration page, making it hard to find and navigate. With the recent addition of tool inheritance support (#6559), this seemed like a good time to:

  1. Give monorepo tasks their own dedicated documentation page
  2. Make it easier to discover and understand the feature
  3. Consolidate all monorepo-related information in one place
  4. Document the new tool inheritance behavior

🤖 Generated with Claude Code


Note

Adds a dedicated Monorepo Tasks doc, updates existing docs to reference it (including tool/env inheritance), and links it in the sidebar.

  • Docs:
    • New: docs/tasks/monorepo.md — consolidated guide covering overview, config, path syntax (//, :), wildcards (..., *), tool/env inheritance, performance tuning, listing, and best practices.
  • Updates:
    • docs/tasks/task-configuration.md: Replaces detailed monorepo section with a brief intro and link to Monorepo Tasks.
    • docs/configuration.md: Refines monorepo root wording, notes subdirectory tool inheritance, and updates link to Monorepo Tasks.
  • Site nav:
    • docs/.vitepress/config.ts: Adds Monorepo Tasks to the Tasks sidebar.

Written by Cursor Bugbot for commit 6caddb7. This will update automatically on new commits. Configure here.

Copilot AI review requested due to automatic review settings October 6, 2025 13:18
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Creates dedicated documentation for monorepo tasks functionality and reorganizes existing documentation by moving content from the task configuration page to a new standalone guide.

  • Extracts comprehensive monorepo task documentation from task-configuration.md to new dedicated page
  • Documents tool inheritance feature for subdirectory tasks
  • Updates cross-references to point to the new monorepo documentation

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
docs/tasks/monorepo.md New comprehensive guide covering monorepo task syntax, configuration, tool inheritance, and best practices
docs/tasks/task-configuration.md Replaced detailed monorepo section with brief overview and link to dedicated documentation
docs/configuration.md Added mention of tool inheritance feature and updated documentation link

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@jdx jdx force-pushed the docs/monorepo-tasks branch from cb7402a to 0a9ca2f Compare October 6, 2025 13:30
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Oct 6, 2025

Hyperfine Performance

mise x -- echo

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2025.10.3 x -- echo 17.6 ± 0.2 17.3 18.6 1.00
mise x -- echo 17.7 ± 0.2 17.3 19.6 1.01 ± 0.02

mise env

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2025.10.3 env 17.1 ± 0.4 16.7 22.1 1.00
mise env 17.3 ± 0.5 16.8 22.2 1.01 ± 0.03

mise hook-env

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2025.10.3 hook-env 16.8 ± 0.6 16.4 26.8 1.00
mise hook-env 17.0 ± 0.4 16.4 21.4 1.01 ± 0.04

mise ls

Command Mean [ms] Min [ms] Max [ms] Relative
mise-2025.10.3 ls 14.7 ± 0.2 14.4 15.4 1.00
mise ls 14.9 ± 0.4 14.4 20.2 1.02 ± 0.03

xtasks/test/perf

Command mise-2025.10.3 mise Variance
install (cached) 194ms ✅ 105ms +84%
ls (cached) 62ms 63ms -1%
bin-paths (cached) 68ms 69ms -1%
task-ls (cached) 465ms 477ms -2%

✅ Performance improvement: install cached is 84%

- Create comprehensive monorepo tasks guide at docs/tasks/monorepo.md
- Document tool inheritance from parent configs
- Update task-configuration.md to reference new monorepo doc
- Update configuration.md to mention tool inheritance feature
- Consolidate all monorepo information in one place

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@jdx jdx force-pushed the docs/monorepo-tasks branch from 0a9ca2f to ee640b6 Compare October 6, 2025 13:41
@jdx jdx requested a review from Copilot October 6, 2025 13:41
@jdx jdx enabled auto-merge (squash) October 6, 2025 13:41
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Comment thread docs/tasks/monorepo.md Outdated
Comment thread docs/tasks/monorepo.md
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@jdx jdx merged commit 310a851 into main Oct 6, 2025
27 checks passed
@jdx jdx deleted the docs/monorepo-tasks branch October 6, 2025 13:52
jdx pushed a commit that referenced this pull request Oct 7, 2025
### 📦 Registry

- add jules by @alefteris in
[#6568](#6568)

### 🐛 Bug Fixes

- **(docs)** improve favicon support for Safari by @jdx in
[#6567](#6567)
- **(github)** download assets via API to respect GITHUB_TOKEN by @roele
in [#6496](#6496)
- **(task)** load toml tasks in `task_config.includes` in system/global
config and monorepo subdirs by @risu729 in
[#6545](#6545)
- **(task)** handle dots in monorepo directory names correctly by @jdx
in [#6571](#6571)

### 📚 Documentation

- **(readme)** add GitHub Issues & Discussions section by @rsyring in
[#6573](#6573)
- **(tasks)** create dedicated monorepo tasks documentation by @jdx in
[#6561](#6561)
- **(tasks)** enhance monorepo documentation with tool comparisons by
@jdx in [#6563](#6563)
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