From e99c684c7132eb726d9c85454cc7290ac5a7bbd1 Mon Sep 17 00:00:00 2001
From: Vance Morrison <vancemorrison@comcast.net>
Date: Thu, 4 Aug 2016 13:13:19 -0700
Subject: [PATCH] Add a table of contents to the book of the runtime

 (so you have one link to go to that represents the entire book)


Commit migrated from https://github.com/dotnet/coreclr/commit/e03a2e34e14db3b74abe7382d830127199e20dc1
---
 docs/coreclr/README.md                | 21 +++++++--------------
 docs/coreclr/botr/_tableOfContents.md | 30 ++++++++++++++++++++++++++++++
 2 files changed, 37 insertions(+), 14 deletions(-)
 create mode 100644 docs/coreclr/botr/_tableOfContents.md

diff --git a/docs/coreclr/README.md b/docs/coreclr/README.md
index 70167e4..db5beea 100644
--- a/docs/coreclr/README.md
+++ b/docs/coreclr/README.md
@@ -56,23 +56,16 @@ Testing and Debugging CoreCLR
 Book of the Runtime
 ===================
 
-- [Book of the Runtime FAQ](botr/botr-faq.md)
+The book of the runtime is a set of chapters that go in depth into various 
+interesting aspects of the design of hte .NET Framework.  
+
+- [Book of the Runtime](botr/_tableOfContents.md)
+
+For you convenience, here are a a few quick links to popular chapters.  
+
 - [Introduction to the Common Language Runtime](botr/intro-to-clr.md)
 - [Garbage Collection Design](botr/garbage-collection.md)
-- [Threading](botr/threading.md)
-- [RyuJIT Overview](botr/ryujit-overview.md)
 - [Type System](botr/type-system.md)
-- [Type Loader](botr/type-loader.md)
-- [Method Descriptor](botr/method-descriptor.md)
-- [Virtual Stub Dispatch](botr/virtual-stub-dispatch.md)
-- [Stack Walking](botr/stackwalking.md)
-- [Mscorlib and Calling Into the Runtime](botr/mscorlib.md)
-- [Data Access Component (DAC) Notes](botr/dac-notes.md)
-- [Profiling](botr/profiling.md)
-- [Implementing Profilability](botr/profilability.md)
-- [What Every Dev needs to Know About Exceptions in the Runtime](botr/exceptions.md)
-- [ReadyToRun Overview](botr/readytorun-overview.md)
-- [CLR ABI](botr/clr-abi.md)
 
 Decoder Rings
 =============
diff --git a/docs/coreclr/botr/_tableOfContents.md b/docs/coreclr/botr/_tableOfContents.md
new file mode 100644
index 0000000..549d3fc
--- /dev/null
+++ b/docs/coreclr/botr/_tableOfContents.md
@@ -0,0 +1,30 @@
+
+Welcome to the Book of the (.NET) Runtime (BOTR).  
+
+Below is a table of contents.   
+
+- [Book of the Runtime FAQ](botr-faq.md)
+- [Introduction to the Common Language Runtime](intro-to-clr.md)
+- [Garbage Collection Design](garbage-collection.md)
+- [Threading](threading.md)
+- [RyuJIT Overview](ryujit-overview.md)  
+  - [Porting RyuJIT to other platforms](porting-ryujit.md)
+- [Type System](type-system.md)
+- [Type Loader](type-loader.md)
+- [Method Descriptor](method-descriptor.md)
+- [Virtual Stub Dispatch](virtual-stub-dispatch.md)
+- [Stack Walking](stackwalking.md)
+- [Mscorlib and Calling Into the Runtime](mscorlib.md)
+- [Data Access Component (DAC) Notes](dac-notes.md)
+- [Profiling](profiling.md)
+- [Implementing Profilability](profilability.md)
+- [What Every Dev needs to Know About Exceptions in the Runtime](exceptions.md)
+- [ReadyToRun Overview](readytorun-overview.md)
+- [CLR ABI](clr-abi.md)
+
+
+It may be possible that this table is not complete.  You can get a complete list 
+by looking at the directory where all the chapters are stored on 
+github.  
+
+* [All book of the runtime (BOTR) chapters on GitHub](https://github.com/vancem/coreclr/tree/master/Documentation/botr)
-- 
2.7.4