From 30ec2d81940ccaed7a07e7d9decfd726b6bb0947 Mon Sep 17 00:00:00 2001 From: "refcell.eth" Date: Mon, 21 Aug 2023 17:20:00 -0400 Subject: [PATCH] feat(docs): Setup Documentation (#6907) * Start adding documentation. * Update README.md --------- Co-authored-by: Matthew Slipper --- docs/README.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 docs/README.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000000..cabb2506b084 --- /dev/null +++ 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.