Official Gradle Documentation Research

Guidance on using the gradle_docs tool for authoritative documentation lookup, including the User Guide, DSL Reference, Release Notes, samples, and API reference.

Searching the User Guide

{
  "query": "tag:userguide working with files",
  "projectRoot": "/absolute/path/to/project"
}

Navigating the DSL Reference

{
  "path": "dsl/org.gradle.api.Project.html",
  "projectRoot": "/absolute/path/to/project"
}

Searching for Samples

Official code samples are indexed with the tag:samples metadata:

{
  "query": "tag:samples toolchains",
  "projectRoot": "/absolute/path/to/project"
}

Searching Javadocs

Technical API documentation is indexed with the tag:javadoc metadata:

{
  "query": "tag:javadoc Project",
  "projectRoot": "/absolute/path/to/project"
}

Best Practices

Getting an Index of Best Practices

First, explore the userguide/ directory to identify the correct files:

{
  "path": "userguide/",
  "projectRoot": "/absolute/path/to/project"
}

This lists the contents of the userguide directory. Look for files starting with best_practices (e.g., best_practices.md, best_practices_dependency_management.md). Once identified, read the main index:

{
  "path": "userguide/best_practices.md",
  "projectRoot": "/absolute/path/to/project"
}

Searching for Best Practices

{
  "query": "tag:best-practices dependency management",
  "projectRoot": "/absolute/path/to/project"
}

Searching for Specific Guidance

{
  "query": "tag:userguide performance best practices",
  "projectRoot": "/absolute/path/to/project"
}

Exploring the Documentation Tree

Use gradle_docs with path="." to explore the root documentation tree:

{
  "path": ".",
  "projectRoot": "/absolute/path/to/project"
}

2.1 KiB Raw Blame History