Document top-level directories
Change-Id: I52889e4823cbeb841c7dc9da12b5fe4c6a79d663
Reviewed-on: https://review.monogon.dev/c/monogon/+/3310
Tested-by: Jenkins CI
Reviewed-by: Lorenz Brun <lorenz@monogon.tech>
diff --git a/build/README.md b/build/README.md
new file mode 100644
index 0000000..3514ef6
--- /dev/null
+++ b/build/README.md
@@ -0,0 +1,4 @@
+# `//build`
+
+This directory contains global build and CI infrastructure which are useful across the entire monorepo, such as toolchains, Bazel libraries and CI config.
+
diff --git a/cloud/README.md b/cloud/README.md
new file mode 100644
index 0000000..eafb512
--- /dev/null
+++ b/cloud/README.md
@@ -0,0 +1,3 @@
+# `//cloud`
+
+`//cloud` contains tooling and libraries for orchestrating Monogon OS clusters.
diff --git a/go/README.md b/go/README.md
new file mode 100644
index 0000000..6574408
--- /dev/null
+++ b/go/README.md
@@ -0,0 +1,3 @@
+# `//go`
+
+Go libraries which are not specific to any component live here. For example, this is a good place to put algorithms or helper libraries.
diff --git a/intellij/README.md b/intellij/README.md
new file mode 100644
index 0000000..97c1d78
--- /dev/null
+++ b/intellij/README.md
@@ -0,0 +1,3 @@
+# `//intellij`
+
+Supporting infrastructure for using the Bazel IntelliJ plugin with our monorepo.
diff --git a/net/README.md b/net/README.md
new file mode 100644
index 0000000..295085c
--- /dev/null
+++ b/net/README.md
@@ -0,0 +1,3 @@
+# `//net`
+
+API definitions and tooling for Monogon OS network definitions. It currently happens to live at the top level because it is shared between //cloud and //metropolis, we should find a more sensible place for it.
diff --git a/osbase/README.md b/osbase/README.md
new file mode 100644
index 0000000..cbfce56
--- /dev/null
+++ b/osbase/README.md
@@ -0,0 +1,3 @@
+# `//osbase`
+
+osbase is our SDK for building an operating system. It contains low-level building blocks for making a "mini OS" such as ktest, the cloud agent or Monogon OS itself.
diff --git a/third_party/README.md b/third_party/README.md
new file mode 100644
index 0000000..bdf4006
--- /dev/null
+++ b/third_party/README.md
@@ -0,0 +1,10 @@
+# `//third_party`
+
+Anything related to importing third party code and making it work with our monorepo lives here:
+
+- Vendored code.
+- Bazel rules for third party code.
+- Patches to thid party code.
+- Lock files and similar package manager definitions (whenever possible - things like `go.mod have to live at the top level, and that's OK too).
+
+First-party code or build rules based *on* a third-party component should not live here.