Start organizing docs better for new foundry structure (#1035)

Still just a first pass but a start! Fixes [this](https://github.com/slackhq/foundry/actions/runs/11350595674/job/31569522435) along the way
slackhq · Oct 15, 2024 · f709582 · f709582
1 parent 1045041
commit f709582
Show file tree

Hide file tree

Showing 16 changed files with 29 additions and 26 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -26,7 +26,7 @@ This includes a whole host of things!
 - Platforms and BOM dependencies (see "Platform plugins" section below).
 - Common lint checks (both on Android and plain JVM projects).
 
-Full docs can be found in the [architecture](architecture) docs.
+Full docs can be found in the [architecture](platforms/gradle/architecture.md) docs.
 
 ### Feature DSL
 
@@ -71,8 +71,7 @@ of our friends at Square).
 
 Gradle's built-in property support is limited and has surprising behavior, so we have our own
 system on top of it that has consistent precedence, `local.properties` support, project-local
-`gradle.properties`, and configuration caching support. Check out `safeProperty()` in
-`PropertyUtil.kt`.
+`gradle.properties`, and configuration caching support. Check out `PropertyResolver`.
 
 ### Dependency Rake
 

diff --git a/docs/architecture.md → docs/platforms/gradle/architecture.md b/docs/architecture.md → docs/platforms/gradle/architecture.md
@@ -39,13 +39,13 @@ Its responsibilities include:
 - Configuring unit tests via `UnitTests`. This also includes configuring the Gradle test retry plugin, if enabled.
 - Configuring NullAway, if enabled.
 - Configuring [Skippy](/tools/skippy).
-- Configuring [Mod Score](/mod-score) tasks.
+- Configuring [Mod Score](../mod-score) tasks.
 
 ### `StandardProjectConfigurations`
 
 This class warrants special mention as it is responsible for the bulk of the configuration applied to projects SGP manages.
 
-- Creates and exposes the [`foundry` extension DSL](/dsl).
+- Creates and exposes the [`foundry` extension DSL](../dsl).
 - Applies common configurations.
   - This largely just sets up the dependency sorter plugin.
 - Applies common JVM configurations.
@@ -59,7 +59,7 @@ All JVM projects (Android, Java, Kotlin) receive some common configuration for t
 
 - Applies the repo's platform project, if any.
 - Applies any BOM dependencies to platform-configurable configurations.
-- Configures the dependency analysis gradle plugin and [`DependencyRake`](/dependency-rake).
+- Configures the dependency analysis gradle plugin and [`DependencyRake`](../dependency-rake).
 - Applies common annotations and common test bundles from version catalogs.
 - Fails on non-androidx support library dependencies.
 - Configure common annotations processors.
@@ -96,7 +96,7 @@ Java projects are fairly simple. Note that these are applied on all projects tha
 - Application projects...
   - have their packaging config set up with some convenience common exclusions and handling common `jniLibs` handling.
   - have v3 and v4 signing enabled by default.
-  - are configured with [`PermissionChecks`](/utilities/#permissionchecks).
+  - are configured with [`PermissionChecks`](../utilities/#permissionchecks).
   - are configured with the Bugsnag gradle plugin, if enabled.
 - Library projects...
   - are configured with an automatic `android.namespace`, if none is manually specified in the buildscript. The namespace is inferred from the project's Gradle path.

diff --git a/docs/bootstrap.md → docs/platforms/gradle/bootstrap.md b/docs/bootstrap.md → docs/platforms/gradle/bootstrap.md
diff --git a/docs/configuration.md → docs/platforms/gradle/configuration.md b/docs/configuration.md → docs/platforms/gradle/configuration.md
diff --git a/docs/dependency-rake.md → docs/platforms/gradle/dependency-rake.md b/docs/dependency-rake.md → docs/platforms/gradle/dependency-rake.md
diff --git a/docs/dsl.md → docs/platforms/gradle/dsl.md b/docs/dsl.md → docs/platforms/gradle/dsl.md
@@ -73,7 +73,7 @@ behavior.
 
 By default, SGP disables androidTests in projects. These can be enabled via the `androidTest()` feature, which will enable the relevant controls in the Android plugin. This can also accept specified variants to enable/disable.
 
-This is important for opting in tests to [AndroidTest APK Aggregation](/utilities/#androidtest-apk-aggregation).
+This is important for opting in tests to [AndroidTest APK Aggregation](../utilities/#androidtest-apk-aggregation).
 
 ### Resources
 
@@ -85,5 +85,5 @@ This can be enabled via the `resources()` feature, which will enable the relevan
 
 ### Permission AllowList
 
-This enables checking of a permission allowlist. See [`PermissionChecks`](/utilities/#permissionchecks) for more
+This enables checking of a permission allowlist. See [`PermissionChecks`](../utilities/#permissionchecks) for more
 details.
diff --git a/docs/formatters-and-analysis.md → ...atforms/gradle/formatters-and-analysis.md b/docs/formatters-and-analysis.md → ...atforms/gradle/formatters-and-analysis.md
diff --git a/docs/lint.md → docs/platforms/gradle/lint.md b/docs/lint.md → docs/platforms/gradle/lint.md
diff --git a/docs/mod-score.md → docs/platforms/gradle/mod-score.md b/docs/mod-score.md → docs/platforms/gradle/mod-score.md
diff --git a/docs/properties.md → docs/platforms/gradle/properties.md b/docs/properties.md → docs/platforms/gradle/properties.md
diff --git a/docs/testing.md → docs/platforms/gradle/testing.md b/docs/testing.md → docs/platforms/gradle/testing.md
diff --git a/docs/thermals-logging.md → docs/platforms/gradle/thermals-logging.md b/docs/thermals-logging.md → docs/platforms/gradle/thermals-logging.md
diff --git a/docs/utilities.md → docs/platforms/gradle/utilities.md b/docs/utilities.md → docs/platforms/gradle/utilities.md
@@ -40,7 +40,7 @@ tasks
 ```
 
 This task is automatically added to whenever a subproject uses
-the `androidTest()` [DSL feature](/dsl/#android-test).
+the `androidTest()` [DSL feature](../dsl/#android-test).
 
 ## `PermissionChecks`
 
@@ -51,7 +51,7 @@ The workflow we use at Slack is like this:
 
 - We check in a `permissionsAllowlist.txt` file in the Slack android repo.
 - This file is owned in GitHub by a specific codeowner rule that adds a permission reviewers group.
-- This file is passed into the `allowListFile` [DSL feature](/dsl/#permission-allowlist) in the application
+- This file is passed into the `allowListFile` [DSL feature](../dsl/#permission-allowlist) in the application
   project.
 - On each build, SGP automatically checks that the permissions present in the release APK manifest match the ones
   defined in the allowlist.

diff --git a/tools/cli/README.md → docs/tools/cli.md b/tools/cli/README.md → docs/tools/cli.md
diff --git a/docs/skippy.md → docs/tools/skippy.md b/docs/skippy.md → docs/tools/skippy.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -2,7 +2,7 @@
 # mkdocs serve
 # mkdocs gh-deploy
 
-site_name: foundry
+site_name: Foundry
 repo_name: foundry
 repo_url: https://github.com/slackhq/foundry
 site_description: "Gradle and IntelliJ build tooling used in Slack's Android projects"
@@ -58,20 +58,24 @@ markdown_extensions:
 
 nav:
   - 'Overview': index.md
-  - 'Architecture': architecture.md
-  - 'Dependency Rake': dependency-rake.md
-  - 'Bootstrap': bootstrap.md
-  - 'DSL': dsl.md
-  - 'Utilities': utilities.md
-  # TODO
-#  - 'Configuration': configuration.md
-#  - 'Lint': lint.md
-#  - 'Testing': testing.md
-#  - 'Skippy': skippy.md
-#  - 'Properties': properties.md
-#  - 'Mod Score': mod-score.md
-#  - 'Formatters & Analysis': formatters-and-analysis.md
-#  - 'Thermals Logging': thermals-logging.md
+  - 'Platforms':
+    - 'Gradle':
+      - 'Architecture': platforms/gradle/architecture.md
+      - 'Dependency Rake': platforms/gradle/dependency-rake.md
+      - 'Bootstrap': platforms/gradle/bootstrap.md
+      - 'DSL': platforms/gradle/dsl.md
+      - 'Utilities': platforms/gradle/utilities.md
+      # TODO
+    #  - 'Configuration': platforms/gradle/configuration.md
+    #  - 'Lint': platforms/gradle/lint.md
+    #  - 'Testing': platforms/gradle/testing.md
+    #  - 'Skippy': platforms/gradle/skippy.md
+    #  - 'Properties': platforms/gradle/properties.md
+    #  - 'Mod Score': platforms/gradle/mod-score.md
+    #  - 'Formatters & Analysis': platforms/gradle/formatters-and-analysis.md
+    #  - 'Thermals Logging': platforms/gradle/thermals-logging.md
+  - 'Tools':
+      - 'CLI': tools/cli.md
   - 'Discussions ⏏': https://github.com/slackhq/foundry/discussions
   - 'Change Log': changelog.md
   - 'API': api/0.x/