From 5adfd80bceee188d95e6cb8cb037d367912ac564 Mon Sep 17 00:00:00 2001 From: Rodrigo Arias Date: Mon, 27 Feb 2023 11:23:00 +0100 Subject: [PATCH] Move user guide docs to a new directory --- doc/{ => user}/concepts.md | 0 doc/{ => user}/emulation/events.md | 0 doc/{ => user}/emulation/fig/model.dot | 0 doc/{ => user}/emulation/fig/model.png | Bin doc/{ => user}/emulation/fig/model.svg | 0 .../emulation/fig/nanos6-task-model.dot | 0 .../emulation/fig/nanos6-task-model.svg | 0 doc/{ => user}/emulation/fig/thread-model.dot | 0 doc/{ => user}/emulation/fig/thread-model.png | Bin doc/{ => user}/emulation/fig/thread-model.svg | 0 doc/{ => user}/emulation/index.md | 0 doc/{ => user}/emulation/nanos6.md | 0 doc/{ => user}/emulation/nosv.md | 0 doc/{ => user}/emulation/ovni.md | 0 doc/{ => user}/fig/instrumentation.dot | 0 doc/{ => user}/fig/instrumentation.svg | 0 doc/{ => user}/fig/palette.svg | 0 doc/{ => user}/fig/subsystem-stack.svg | 0 doc/{ => user}/fig/visualization.png | Bin doc/{ => user}/installation.md | 0 doc/{ => user}/runtime/distributed.md | 0 doc/{ => user}/runtime/fig/event-jumbo.svg | 0 .../runtime/fig/event-normal-payload.svg | 0 doc/{ => user}/runtime/fig/event-normal.svg | 0 doc/{ => user}/runtime/fig/stream.svg | 0 doc/{ => user}/runtime/kernel.md | 0 doc/{ => user}/runtime/trace_spec.md | 0 doc/{ => user}/runtime/tracing.md | 0 mkdocs.yml | 27 +++++++++--------- 29 files changed, 14 insertions(+), 13 deletions(-) rename doc/{ => user}/concepts.md (100%) rename doc/{ => user}/emulation/events.md (100%) rename doc/{ => user}/emulation/fig/model.dot (100%) rename doc/{ => user}/emulation/fig/model.png (100%) rename doc/{ => user}/emulation/fig/model.svg (100%) rename doc/{ => user}/emulation/fig/nanos6-task-model.dot (100%) rename doc/{ => user}/emulation/fig/nanos6-task-model.svg (100%) rename doc/{ => user}/emulation/fig/thread-model.dot (100%) rename doc/{ => user}/emulation/fig/thread-model.png (100%) rename doc/{ => user}/emulation/fig/thread-model.svg (100%) rename doc/{ => user}/emulation/index.md (100%) rename doc/{ => user}/emulation/nanos6.md (100%) rename doc/{ => user}/emulation/nosv.md (100%) rename doc/{ => user}/emulation/ovni.md (100%) rename doc/{ => user}/fig/instrumentation.dot (100%) rename doc/{ => user}/fig/instrumentation.svg (100%) rename doc/{ => user}/fig/palette.svg (100%) rename doc/{ => user}/fig/subsystem-stack.svg (100%) rename doc/{ => user}/fig/visualization.png (100%) rename doc/{ => user}/installation.md (100%) rename doc/{ => user}/runtime/distributed.md (100%) rename doc/{ => user}/runtime/fig/event-jumbo.svg (100%) rename doc/{ => user}/runtime/fig/event-normal-payload.svg (100%) rename doc/{ => user}/runtime/fig/event-normal.svg (100%) rename doc/{ => user}/runtime/fig/stream.svg (100%) rename doc/{ => user}/runtime/kernel.md (100%) rename doc/{ => user}/runtime/trace_spec.md (100%) rename doc/{ => user}/runtime/tracing.md (100%) diff --git a/doc/concepts.md b/doc/user/concepts.md similarity index 100% rename from doc/concepts.md rename to doc/user/concepts.md diff --git a/doc/emulation/events.md b/doc/user/emulation/events.md similarity index 100% rename from doc/emulation/events.md rename to doc/user/emulation/events.md diff --git a/doc/emulation/fig/model.dot b/doc/user/emulation/fig/model.dot similarity index 100% rename from doc/emulation/fig/model.dot rename to doc/user/emulation/fig/model.dot diff --git a/doc/emulation/fig/model.png b/doc/user/emulation/fig/model.png similarity index 100% rename from doc/emulation/fig/model.png rename to doc/user/emulation/fig/model.png diff --git a/doc/emulation/fig/model.svg b/doc/user/emulation/fig/model.svg similarity index 100% rename from doc/emulation/fig/model.svg rename to doc/user/emulation/fig/model.svg diff --git a/doc/emulation/fig/nanos6-task-model.dot b/doc/user/emulation/fig/nanos6-task-model.dot similarity index 100% rename from doc/emulation/fig/nanos6-task-model.dot rename to doc/user/emulation/fig/nanos6-task-model.dot diff --git a/doc/emulation/fig/nanos6-task-model.svg b/doc/user/emulation/fig/nanos6-task-model.svg similarity index 100% rename from doc/emulation/fig/nanos6-task-model.svg rename to doc/user/emulation/fig/nanos6-task-model.svg diff --git a/doc/emulation/fig/thread-model.dot b/doc/user/emulation/fig/thread-model.dot similarity index 100% rename from doc/emulation/fig/thread-model.dot rename to doc/user/emulation/fig/thread-model.dot diff --git a/doc/emulation/fig/thread-model.png b/doc/user/emulation/fig/thread-model.png similarity index 100% rename from doc/emulation/fig/thread-model.png rename to doc/user/emulation/fig/thread-model.png diff --git a/doc/emulation/fig/thread-model.svg b/doc/user/emulation/fig/thread-model.svg similarity index 100% rename from doc/emulation/fig/thread-model.svg rename to doc/user/emulation/fig/thread-model.svg diff --git a/doc/emulation/index.md b/doc/user/emulation/index.md similarity index 100% rename from doc/emulation/index.md rename to doc/user/emulation/index.md diff --git a/doc/emulation/nanos6.md b/doc/user/emulation/nanos6.md similarity index 100% rename from doc/emulation/nanos6.md rename to doc/user/emulation/nanos6.md diff --git a/doc/emulation/nosv.md b/doc/user/emulation/nosv.md similarity index 100% rename from doc/emulation/nosv.md rename to doc/user/emulation/nosv.md diff --git a/doc/emulation/ovni.md b/doc/user/emulation/ovni.md similarity index 100% rename from doc/emulation/ovni.md rename to doc/user/emulation/ovni.md diff --git a/doc/fig/instrumentation.dot b/doc/user/fig/instrumentation.dot similarity index 100% rename from doc/fig/instrumentation.dot rename to doc/user/fig/instrumentation.dot diff --git a/doc/fig/instrumentation.svg b/doc/user/fig/instrumentation.svg similarity index 100% rename from doc/fig/instrumentation.svg rename to doc/user/fig/instrumentation.svg diff --git a/doc/fig/palette.svg b/doc/user/fig/palette.svg similarity index 100% rename from doc/fig/palette.svg rename to doc/user/fig/palette.svg diff --git a/doc/fig/subsystem-stack.svg b/doc/user/fig/subsystem-stack.svg similarity index 100% rename from doc/fig/subsystem-stack.svg rename to doc/user/fig/subsystem-stack.svg diff --git a/doc/fig/visualization.png b/doc/user/fig/visualization.png similarity index 100% rename from doc/fig/visualization.png rename to doc/user/fig/visualization.png diff --git a/doc/installation.md b/doc/user/installation.md similarity index 100% rename from doc/installation.md rename to doc/user/installation.md diff --git a/doc/runtime/distributed.md b/doc/user/runtime/distributed.md similarity index 100% rename from doc/runtime/distributed.md rename to doc/user/runtime/distributed.md diff --git a/doc/runtime/fig/event-jumbo.svg b/doc/user/runtime/fig/event-jumbo.svg similarity index 100% rename from doc/runtime/fig/event-jumbo.svg rename to doc/user/runtime/fig/event-jumbo.svg diff --git a/doc/runtime/fig/event-normal-payload.svg b/doc/user/runtime/fig/event-normal-payload.svg similarity index 100% rename from doc/runtime/fig/event-normal-payload.svg rename to doc/user/runtime/fig/event-normal-payload.svg diff --git a/doc/runtime/fig/event-normal.svg b/doc/user/runtime/fig/event-normal.svg similarity index 100% rename from doc/runtime/fig/event-normal.svg rename to doc/user/runtime/fig/event-normal.svg diff --git a/doc/runtime/fig/stream.svg b/doc/user/runtime/fig/stream.svg similarity index 100% rename from doc/runtime/fig/stream.svg rename to doc/user/runtime/fig/stream.svg diff --git a/doc/runtime/kernel.md b/doc/user/runtime/kernel.md similarity index 100% rename from doc/runtime/kernel.md rename to doc/user/runtime/kernel.md diff --git a/doc/runtime/trace_spec.md b/doc/user/runtime/trace_spec.md similarity index 100% rename from doc/runtime/trace_spec.md rename to doc/user/runtime/trace_spec.md diff --git a/doc/runtime/tracing.md b/doc/user/runtime/tracing.md similarity index 100% rename from doc/runtime/tracing.md rename to doc/user/runtime/tracing.md diff --git a/mkdocs.yml b/mkdocs.yml index 897236a..13308da 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -19,19 +19,20 @@ markdown_extensions: separator: "_" nav: - index.md - - concepts.md - - installation.md - - 'Runtime': - - runtime/tracing.md - - runtime/distributed.md - - runtime/kernel.md - - runtime/trace_spec.md - - 'Emulation': - - emulation/index.md - - emulation/ovni.md - - emulation/nosv.md - - emulation/nanos6.md - - emulation/events.md + - 'User guide': + - user/concepts.md + - user/installation.md + - 'Runtime': + - user/runtime/tracing.md + - user/runtime/distributed.md + - user/runtime/kernel.md + - user/runtime/trace_spec.md + - 'Emulation': + - user/emulation/index.md + - user/emulation/ovni.md + - user/emulation/nosv.md + - user/emulation/nanos6.md + - user/emulation/events.md - 'Developer guide': - dev/index.md - dev/channels.md