Use more footnotes in docs (#1400)

Co-authored-by: Copilot <[email protected]>

Author: Goooler

docs/README.md

@@ -8,7 +8,7 @@
 Shadow is a Gradle plugin for combining a project's dependency classes and resources into a single
 output Jar.
 The combined Jar is often referred to a _fat-jar_ or _uber-jar_.
-Shadow utilizes [`JarInputStream`](https://docs.oracle.com/javase/8/docs/api/java/util/jar/JarInputStream.html) and [`JarOutputStream`](https://docs.oracle.com/javase/8/docs/api/java/util/jar/JarOutputStream.html) to efficiently process dependent libraries
+Shadow utilizes [`JarInputStream`][JarInputStream] and [`JarOutputStream`][JarOutputStream] to efficiently process dependent libraries
 into the output jar without incurring the I/O overhead of expanding the jars to disk.
 
 !!! warning "Plugin ID Change"
@@ -57,3 +57,8 @@ These issues often manifest themselves as binary incompatibilities in either the
 
 By utilizing Shadow's ability to _relocate_ the package names for dependencies, a library author can ensure that the
 library's dependencies will not conflict with the same dependency being declared by the downstream application.
+
+
+
+[JarInputStream]: https://docs.oracle.com/javase/8/docs/api/java/util/jar/JarInputStream.html
+[JarOutputStream]: https://docs.oracle.com/javase/8/docs/api/java/util/jar/JarOutputStream.html

docs/application-plugin/README.md

@@ -1,11 +1,11 @@
 # Integrating with Application Plugin
 
-Shadow reacts to the presence of Gradle's
-[`application`](https://docs.gradle.org/current/userguide/application_plugin.html) plugin and will automatically
-configure additional tasks for running the shadowed JAR and creating distributions containing the shadowed JAR.
+Shadow reacts to the presence of Gradle's [`application`][application] plugin and will automatically configure
+additional tasks for running the shadowed JAR and creating distributions containing the shadowed JAR.
 
-Just like the normal `jar` task, when the `application` plugin is applied, the `shadowJar` manifest will be
-configured to contain the `Main-Class` attribute with the value specified in the project's `mainClassName` attribute.
+Just like the normal [`Jar`][Jar] task, when the [`application`][application] plugin is applied,
+the [`ShadowJar`][ShadowJar] manifest will be configured to contain the `Main-Class` attribute with the value specified
+in the project's `application.mainClass` attribute.
 
 === "Kotlin"
 
@@ -37,9 +37,8 @@ configured to contain the `Main-Class` attribute with the value specified in the
 
 When applied along with the `application` plugin, the `runShadow` task will be created for starting
 the application from the shadowed JAR.
-The `runShadow` task is a [`JavaExec`](https://docs.gradle.org/current/dsl/org.gradle.api.tasks.JavaExec.html)
-task that is configured to execute `java -jar myproject-all.jar`.
-It can be configured the same as any other `JavaExec` task.
+The `runShadow` task is a [`JavaExec`][JavaExec] task that is configured to execute `java -jar myproject-all.jar`.
+It can be configured the same as any other [`JavaExec`][JavaExec] task.
 
 === "Kotlin"
 
@@ -81,10 +80,9 @@ It can be configured the same as any other `JavaExec` task.
 
 ## Distributing the Shadow JAR
 
-The Shadow plugin will also configure distribution tasks when in the presence of the `application` plugin.
-The plugin will create `shadowDistZip` and `shadowDistTar` which creates Zip and Tar distributions
-respectively.
-Each distribution will contain the shadowed JAR file along with the necessary start scripts to launch
+The Shadow plugin will also configure distribution tasks when in the presence of the [`application`][application]
+plugin. The plugin will create `shadowDistZip` and `shadowDistTar` which creates Zip and Tar distributions
+respectively. Each distribution will contain the shadowed JAR file along with the necessary start scripts to launch
 the application.
 
 Additionally, the plugin will create the `installShadowDist` and `startShadowScripts` tasks which stages the necessary
@@ -142,5 +140,12 @@ You can also add more files into the distribution like:
     }
     ```
 
-View [the official doc described](https://docs.gradle.org/current/userguide/distribution_plugin.html#distribution_plugin)
+View [The Distribution Plugin](https://docs.gradle.org/current/userguide/distribution_plugin.html#distribution_plugin)
 for more information about configuring distributions.
+
+
+
+[Jar]: https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Jar.html
+[JavaExec]: https://docs.gradle.org/current/dsl/org.gradle.api.tasks.JavaExec.html
+[ShadowJar]: ../api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/index.html
+[application]: https://docs.gradle.org/current/userguide/application_plugin.html

docs/configuration/README.md

@@ -1,38 +1,32 @@
 # Configuring Shadow
 
-The [`ShadowJar`](../api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/index.html) task type extends from Gradle's
-[`Jar`](https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Jar.html) type.
-This means that all attributes and methods available on `Jar` are also available on
-[`ShadowJar`](../api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/index.html).
-Refer the _Gradle User Guide_ for [Jar](https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Jar.html) for
-details.
+The [`ShadowJar`][ShadowJar] task type extends from Gradle's [`Jar`][Jar] type.
+This means that all attributes and methods available on [`Jar`][Jar] are also available on [`ShadowJar`][ShadowJar].
+
 
 ## Configuring Output Name
 
-Shadow configures the default `shadowJar` task to set the output JAR's
+Shadow configures the default [`ShadowJar`][ShadowJar] task to set the output JAR's
 
-- [`archiveAppendix`](https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Jar.html#org.gradle.api.tasks.bundling.Jar:archiveAppendix)
-- [`archiveBaseName`](https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Jar.html#org.gradle.api.tasks.bundling.Jar:archiveBaseName)
-- [`archiveExtension`](https://docs.gradle.org/current/dsl/org.gradle.jvm.tasks.Jar.html#org.gradle.jvm.tasks.Jar:archiveExtension)
-- [`archiveFile`](https://docs.gradle.org/current/dsl/org.gradle.jvm.tasks.Jar.html#org.gradle.jvm.tasks.Jar:archiveFile)
-- [`archiveFileName`](https://docs.gradle.org/current/dsl/org.gradle.jvm.tasks.Jar.html#org.gradle.jvm.tasks.Jar:archiveFileName)
-- [`archiveVersion`](https://docs.gradle.org/current/dsl/org.gradle.jvm.tasks.Jar.html#org.gradle.jvm.tasks.Jar:archiveVersion)
-- [`destinationDirectory`](https://docs.gradle.org/current/dsl/org.gradle.jvm.tasks.Jar.html#org.gradle.jvm.tasks.Jar:destinationDirectory)
+- [`archiveAppendix`][archiveAppendix]
+- [`archiveBaseName`][archiveBaseName]
+- [`archiveExtension`][archiveExtension]
+- [`archiveFile`][archiveFile]
+- [`archiveFileName`][archiveFileName]
+- [`archiveVersion`][archiveVersion]
+- [`destinationDirectory`][destinationDirectory]
 
-to the same default values as Gradle does for all `Jar` tasks.
-Additionally, it configures the
-[`archiveClassifier`](https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Jar.html#org.gradle.api.tasks.bundling.Jar:archiveClassifier)
-to be `all`. The listed ones are not full, you can view all the properties in 
-[`Jar`](https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Jar.html).
-The output shadowed JAR file will be named with the following format:
+to the same default values as Gradle does for all [`Jar`][Jar] tasks. Additionally, it configures the
+[`archiveClassifier`][archiveClassifier] to be `all`. The listed ones are not full, you can view all the properties in 
+[`Jar`][Jar]. The output shadowed JAR file will be named with the following format:
 
 ```
 archiveBaseName-$archiveAppendix-$archiveVersion-$archiveClassifier.$archiveExtension
 ```
 
-If working with a Gradle project with the name `myApp` and version `1.0`, the default `shadowJar` task will output a
-file at: `build/libs/myApp-1.0-all.jar`. You can override the properties listed above to change the output name of the 
-shadowed JAR file. e.g.
+If working with a Gradle project with the name `myApp` and version `1.0`, the default [`ShadowJar`][ShadowJar] task will
+output a file at: `build/libs/myApp-1.0-all.jar`. You can override the properties listed above to change the output name
+of the shadowed JAR file. e.g.
 
 === "Kotlin"
 
@@ -64,10 +58,10 @@ they are still required for runtime execution.
 In these scenarios, Shadow creates a `shadow` configuration to declare these dependencies.
 Dependencies added to the `shadow` configuration are **not** bundled into the output JAR.
 Think of `configurations.shadow` as unmerged, runtime dependencies.
-The integration with the `maven-publish` plugin will automatically configure dependencies added
+The integration with the [`maven-publish`][maven-publish] plugin will automatically configure dependencies added
 to `configurations.shadow` as `RUNTIME` scope dependencies in the resulting POM file.
 
-Additionally, Shadow automatically configures the manifest of the `shadowJar` task to contain a `Class-Path` entry
+Additionally, Shadow automatically configures the manifest of the [`ShadowJar`][ShadowJar] task to contain a `Class-Path` entry
 in the JAR manifest.
 The value of the `Class-Path` entry is the name of all dependencies resolved in the `shadow` configuration
 for the project.
@@ -99,9 +93,9 @@ When deploying a shadowed JAR as an execution JAR, it is important to note that
 
 ## Configuring the JAR Manifest
 
-Beyond the automatic configuration of the `Class-Path` entry, the `shadowJar` manifest is configured in a number of ways.
-First, the manifest for the `shadowJar` task is configured to __inherit__ from the manifest of the standard `jar` task.
-This means that any configuration performed on the `jar` task will propagate to the `shadowJar` tasks.
+Beyond the automatic configuration of the `Class-Path` entry, the [`ShadowJar`][ShadowJar] manifest is configured in a number of ways.
+First, the manifest for the [`ShadowJar`][ShadowJar] task is configured to __inherit__ from the manifest of the standard [`Jar`][Jar] task.
+This means that any configuration performed on the [`Jar`][Jar] task will propagate to the [`ShadowJar`][ShadowJar] tasks.
 
 === "Kotlin"
 
@@ -129,7 +123,7 @@ Inspecting the `META-INF/MANIFEST.MF` entry in the JAR file will reveal the foll
 Class-Path: /libs/a.jar
 ```
 
-If it is desired to inherit a manifest from a JAR task other than the standard `jar` task, the `inheritFrom` methods
+If it is desired to inherit a manifest from a JAR task other than the standard [`Jar`][Jar] task, the `inheritFrom` methods
 on the `shadowJar.manifest` object can be used to configure the upstream.
 
 === "Kotlin"
@@ -162,8 +156,7 @@ on the `shadowJar.manifest` object can be used to configure the upstream.
 
 ## Adding Extra Files
 
-The `shadowJar` task is a subclass of the `Jar` task, which means that the 
-[Jar.from](https://docs.gradle.org/current/dsl/org.gradle.jvm.tasks.Jar.html#org.gradle.jvm.tasks.Jar:from(java.lang.Object,%20org.gradle.api.Action)) 
+The [`ShadowJar`][ShadowJar] task is a subclass of the [`Jar`][Jar] task, which means that the[`Jar.from`][Jar.from]
 method can be used to add extra files.
 
 === "Kotlin"
@@ -187,3 +180,19 @@ method can be used to add extra files.
       }
     }
     ```
+
+
+
+[Jar.from]: https://docs.gradle.org/current/dsl/org.gradle.jvm.tasks.Jar.html#org.gradle.jvm.tasks.Jar:from(java.lang.Object,%20org.gradle.api.Action)
+[Jar]: https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Jar.html
+[ShadowJar]: ../api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/index.html
+[application]: https://docs.gradle.org/current/userguide/application_plugin.html
+[archiveAppendix]: https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Jar.html#org.gradle.api.tasks.bundling.Jar:archiveAppendix
+[archiveBaseName]: https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Jar.html#org.gradle.api.tasks.bundling.Jar:archiveBaseName
+[archiveClassifier]: https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Jar.html#org.gradle.api.tasks.bundling.Jar:archiveClassifier
+[archiveExtension]: https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Jar.html#org.gradle.api.tasks.bundling.Jar:archiveExtension
+[archiveFileName]: https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Jar.html#org.gradle.api.tasks.bundling.Jar:archiveFileName
+[archiveFile]: https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Jar.html#org.gradle.api.tasks.bundling.Jar:archiveFile
+[archiveVersion]: https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Jar.html#org.gradle.api.tasks.bundling.Jar:archiveVersion
+[destinationDirectory]: https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Jar.html#org.gradle.api.tasks.bundling.Jar:destinationDirectory
+[maven-publish]: https://docs.gradle.org/current/userguide/publishing_maven.html

docs/configuration/dependencies/README.md

@@ -1,9 +1,8 @@
 # Configuring Shadowed Dependencies
 
-Shadow configures the default `shadowJar` task to merge all dependencies from the project's `runtimeClasspath` configuration
-into the final JAR.
-The configurations from which to source dependencies for the merging can be configured using the `configurations` property
-of the [`ShadowJar`](../../api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/index.html) task type.
+Shadow configures the default [`ShadowJar`][ShadowJar] task to merge all dependencies from the project's `runtimeClasspath` configuration
+into the final JAR. The configurations from which to source dependencies for the merging can be configured using the
+[`configurations`][ShadowJar.configurations] property of the [`ShadowJar`][ShadowJar] task type.
 
 === "Kotlin"
 
@@ -21,18 +20,18 @@ of the [`ShadowJar`](../../api/shadow/com.github.jengelman.gradle.plugins.shadow
     }
     ```
 
-The above code sample would configure the `shadowJar` task to merge dependencies from only the `compileClasspath` configuration.
+The above code sample would configure the [`ShadowJar`][ShadowJar] task to merge dependencies from only the `compileClasspath` configuration.
 This means any dependency declared in the `runtimeOnly` configuration would be **not** be included in the final JAR.
 
-> Note the literal use of `project.configurations` when setting the `configurations` attribute of a
-[`ShadowJar`](../../api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/index.html) task.
+> Note the literal use of [`project.configurations`][Project.configurations] when setting the
+[`configurations`][ShadowJar.configurations] attribute of a [`ShadowJar`][ShadowJar] task.
 This is **required**. It may be tempting to specify `configurations = [configurations.compileClasspath]` but this will not
-have the intended effect, as `configurations.compile` will try to delegate to the `configurations` property of the [`ShadowJar`](../../api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/index.html) task instead of the `project`
+have the intended effect, as `configurations.compile` will try to delegate to the
+[`configurations`][ShadowJar.configurations] property of the [`ShadowJar`][ShadowJar] task instead of the `project`
 
 ## Embedding Jar Files Inside Your Shadow Jar
 
-The `shadowJar` task is a subclass of the `Jar` task, which means that the
-[Jar.from](https://docs.gradle.org/current/dsl/org.gradle.jvm.tasks.Jar.html#org.gradle.jvm.tasks.Jar:from(java.lang.Object,%20org.gradle.api.Action))
+The [`ShadowJar`][ShadowJar] task is a subclass of the [`Jar`][Jar] task, which means that the [`Jar.from`][Jar.from]
 method can be used to add extra files.
 
 === "Kotlin"
@@ -72,12 +71,11 @@ See also [Adding Extra Files](../README.md#adding-extra-files)
 ## Filtering Dependencies
 
 Individual dependencies can be filtered from the final JAR by using the `dependencies` block of a
-[`ShadowJar`](../../api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/index.html) task.
-Dependency filtering does **not** apply to transitive dependencies.
+[`ShadowJar`][ShadowJar] task. Dependency filtering does **not** apply to transitive dependencies.
 That is, excluding a dependency does not exclude any of its dependencies from the final JAR.
 
 The `dependency` blocks provides a number of methods for resolving dependencies using the notations familiar from
-Gradle's `configurations` block.
+Gradle's [`project.configurations`][Project.configurations] block.
 
 === "Kotlin"
 
@@ -306,7 +304,7 @@ You can also use type-safe project accessors or version catalog accessors to fil
 ### Programmatically Selecting Dependencies to Filter
 
 If more complex decisions are needed to select the dependencies to be included, the
-[`dependencies`](../../api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/dependencies.html)
+[`ShadowJar.dependencies`][ShadowJar.dependencies]
 block provides a method that accepts a `Closure` for selecting dependencies.
 
 === "Kotlin"
@@ -340,3 +338,12 @@ block provides a method that accepts a `Closure` for selecting dependencies.
       }
     }
     ```
+
+
+
+[Jar.from]: https://docs.gradle.org/current/dsl/org.gradle.jvm.tasks.Jar.html#org.gradle.jvm.tasks.Jar:from(java.lang.Object,%20org.gradle.api.Action)
+[Jar]: https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Jar.html
+[ShadowJar.configurations]: ../../api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/configurations.html
+[ShadowJar.dependencies]: ../../api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/dependencies.html
+[ShadowJar]: ../../api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/index.html
+[Project.configurations]: https://docs.gradle.org/current/dsl/org.gradle.api.Project.html#org.gradle.api.Project:configurations

docs/configuration/filtering/README.md

@@ -1,15 +1,11 @@
 # Filtering Shadow Jar Contents
 
 The final contents of a shadow JAR can be filtered using the `exclude` and `include` methods inherited from Gradle's
-`Jar` task type.
+[`Jar`][Jar] task type.
 
-Refer to the [Jar](https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Jar.html) documentation for details
-on the various versions of the methods and their behavior.
-
-When using `exclude`/`include` with a `ShadowJar` task, the resulting copy specs are applied to the _final_ JAR
-contents.
-This means that, the configuration is applied to the individual files from both the project source set or _any_
-of the dependencies to be merged.
+When using `exclude`/`include` with a [`ShadowJar`][ShadowJar] task, the resulting copy specs are applied to the
+_final_ JAR contents. This means that, the configuration is applied to the individual files from both the project
+source set or _any_ of the dependencies to be merged.
 
 === "Kotlin"
 
@@ -28,7 +24,7 @@ of the dependencies to be merged.
     ```
 
 
-Excludes and includes can be combined just like a normal `Jar` task, with `excludes` taking precedence over `includes`.
+Excludes and includes can be combined just like a normal [`Jar`][Jar] task, with `excludes` taking precedence over `includes`.
 Additionally, ANT style patterns can be used to match multiple files.
 
 === "Kotlin"
@@ -50,3 +46,8 @@ Additionally, ANT style patterns can be used to match multiple files.
       exclude 'a2.properties'
     }
     ```
+
+
+
+[Jar]: https://docs.gradle.org/current/dsl/org.gradle.api.tasks.bundling.Jar.html
+[ShadowJar]: ../../api/shadow/com.github.jengelman.gradle.plugins.shadow.tasks/-shadow-jar/index.html