tkonolige commented on a change in pull request #6097:
URL: https://github.com/apache/incubator-tvm/pull/6097#discussion_r457766222
##########
File path: docs/dev/index.rst
##########
@@ -15,28 +15,327 @@
specific language governing permissions and limitations
under the License.
-Design and Developer Guide
-==========================
+Design and Architecture
+=======================
+
+This document is intended for developers who want to understand the
+architecture of TVM and/or actively develop on the project.
+This page is organized as follows:
+
+- The `Example Compilation Flow Walkthrough`_ section is a walk through of a
typical compilation flow explaining each component used during compilation.
+- The `Logical Architecture Components`_ section describes the logical
components.
+ The sections after are specific guides focused on each logical component,
organized
+ by the component's name.
+- The `How Tos`_ section contains useful tutorials to solve specific
development problems.
+
+This guide provides a few complementary views of the architecture.
+First, we review a single end to end compilation flow and discuss the key data
structures and the transformations.
+This runtime-based view focuses on the interactions of each components when
running the compiler.
+Then we will review the logical modules of the codebase and their
relationship. This part provides a static overarching view of the design.
+
+To get started, please read the `Example Compilation Flow Walkthrough`_
section first for the runtime-based view.
+You can then refer to the architecture diagram in `Logical Architecture
Components`_.
+Each architecture component section contains a short introduction to the
corresponding component
+and links to detailed guides that you can dive into.
+Feel free to browse the `How Tos`_ to useful development tips.
Review comment:
It might make sense to merge these two paragraphs into the list above.
It seems like we are stating the same things multiple times.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
