feat(docs): Setup Documentation (#6907)

* Start adding documentation. * Update README.md --------- Co-authored-by: Matthew Slipper <[email protected]>
ethereum-optimism · Aug 21, 2023 · 30ec2d8 · 30ec2d8
1 parent 3626d11
commit 30ec2d8
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,8 @@
+## Optimism Monorepo Documentation
+
+The `docs/` directory contains Optimism documentation closely tied to the implementation details of the monorepo (https://github.com/ethereum-optimism/optimism).
+
+The directory layout is divided into the following sub-directories.
+
+- [`postmortems/`](./postmortems/): Timestamped post-mortem documents.
+- [`security-reviews`](./security-reviews/): Audit summaries and other security review documents.