aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorFelix Mulder <felix.mulder@gmail.com>2016-10-04 13:14:43 +0200
committerFelix Mulder <felix.mulder@gmail.com>2016-10-06 16:39:39 +0200
commit74b463012cbcc0e147ce0c52e81967948447841d (patch)
tree4e24a0421ecf0b50827c44c2b38c849638fe4069 /docs
parent4fa7c71af100d45bce37c2cce0890c1d8365dbc4 (diff)
downloaddotty-74b463012cbcc0e147ce0c52e81967948447841d.tar.gz
dotty-74b463012cbcc0e147ce0c52e81967948447841d.tar.bz2
dotty-74b463012cbcc0e147ce0c52e81967948447841d.zip
Add index.md
Diffstat (limited to 'docs')
-rw-r--r--docs/index.md31
-rw-r--r--docs/internals/contexts.md (renamed from docs/contexts.md)0
2 files changed, 31 insertions, 0 deletions
diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 000000000..899dfb933
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,31 @@
+Dotty Documentation
+===================
+The Dotty compiler is currently somewhat lacking in documentation - PRs
+welcome! But, we've attempted to gather the most essential knowledge in these
+pages.
+
+Index
+-----
+* [Blog](blog/) posts written for scala-lang.org or dotty.epfl.ch
+* [Contributing](contributing/)
+ - [Eclipse](contributing/eclipse.md) setting up dev environment
+ - [Intellij-IDEA](contributing/intellij-idea.md) setting up dev environment
+ - [Getting Started](contributing/gettings-started.md) details on how to run
+ tests, use the cli scripts
+ - [Workflow](contributing/workflow.md) common dev patterns and hints
+* [Internals](internals/) documents the compiler internals
+ - [Backend](internals/backend.md) details on the bytecode backend
+ - [Contexts](internals/contexts.md) details the use of `Context` in the
+ compiler
+ - [Higher Kinded Type Scheme](internals/higher-kinded-v2.md)
+ scheme
+ - [Project Structure](internals/overall-structure.md)
+ of the project
+ - [Periods](internals/periods.md)
+* [Usage](usage/)
+ - [Migrating from Scala 2](usage/migrating.md)
+ - [Using Dotty with sbt](usage/sbt-projects.md)
+* [Differences between DOT and Dotty](difference-dot-dotty.md) differences between the type
+ calculus and Dotty
+* [Dotty vs Scala2](dotc-scalac.md)
+* [Type System](type-system.md)
diff --git a/docs/contexts.md b/docs/internals/contexts.md
index fd4aa354c..fd4aa354c 100644
--- a/docs/contexts.md
+++ b/docs/internals/contexts.md