From 909d7f3c05e24f443ce919583324d6e6aca0861a Mon Sep 17 00:00:00 2001 From: Keiichi Watanabe Date: Wed, 22 Sep 2021 00:11:54 +0900 Subject: [PATCH] docs: Add ARCHITECTURE.md It's a common idea to have ARCHITECTURE.md next to README.md and CONTRIBUTING.md [1]. So, let's do so instead of having the doc only under mdbook. [1] https://matklad.github.io//2021/02/06/ARCHITECTURE.md.html BUG=b:195003973 TEST=mdbook build Change-Id: I8d3f479ba65c7f85865c51b5c22fb5b37d6e8f78 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3188675 Commit-Queue: Dennis Kempin Tested-by: kokoro Reviewed-by: Chirantan Ekbote Reviewed-by: Dennis Kempin --- .../src/appendix/architectural_overview.md => ARCHITECTURE.md | 2 +- docs/book/src/SUMMARY.md | 2 +- docs/book/src/architecture.md | 1 + 3 files changed, 3 insertions(+), 2 deletions(-) rename docs/book/src/appendix/architectural_overview.md => ARCHITECTURE.md (99%) create mode 100644 docs/book/src/architecture.md diff --git a/docs/book/src/appendix/architectural_overview.md b/ARCHITECTURE.md similarity index 99% rename from docs/book/src/appendix/architectural_overview.md rename to ARCHITECTURE.md index 4ad44fb743..4462fcc488 100644 --- a/docs/book/src/appendix/architectural_overview.md +++ b/ARCHITECTURE.md @@ -1,4 +1,4 @@ -# Architectural Overview (last edit: January 21, 2020) +# Architecture The principle characteristics of crosvm are: diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md index 1c1c99535a..39467d2698 100644 --- a/docs/book/src/SUMMARY.md +++ b/docs/book/src/SUMMARY.md @@ -9,13 +9,13 @@ - [System Requirements](./running_crosvm/requirements.md) - [Features](./running_crosvm/features.md) - [Devices](./running_crosvm/devices.md) +- [Architecture](./architecture.md) - [Contributing](./contributing.md) -------------------------------------------------------------------------------- - [Appendix](./appendix/index.md) - - [Architectural Overview](./appendix/architectural_overview.md) - [Example Usage (Outdated)](./appendix/example_usage.md) - [Sandboxing](./appendix/sandboxing.md) - [Seccomp](./appendix/seccomp.md) diff --git a/docs/book/src/architecture.md b/docs/book/src/architecture.md new file mode 100644 index 0000000000..4708086a40 --- /dev/null +++ b/docs/book/src/architecture.md @@ -0,0 +1 @@ +{{#include ../../../ARCHITECTURE.md}}