aboutsummaryrefslogtreecommitdiff
path: root/docs/docs/index.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/docs/index.md')
-rw-r--r--docs/docs/index.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/docs/docs/index.md b/docs/docs/index.md
new file mode 100644
index 000000000..b8c5e9c20
--- /dev/null
+++ b/docs/docs/index.md
@@ -0,0 +1,34 @@
+---
+layout: default
+title: "Docs"
+---
+
+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/)
+* Usage
+ - [Migrating from Scala 2](usage/migrating.md)
+ - [Using Dotty with sbt](usage/sbt-projects.md)
+* Contributing
+ - [Getting Started](contributing/getting-started.md) details on how to run
+ tests, use the cli scripts
+ - [Workflow](contributing/workflow.md) common dev patterns and hints
+ - [Eclipse](contributing/eclipse.md) setting up dev environment
+ - [Intellij-IDEA](contributing/intellij-idea.md) setting up dev environment
+* Internals document the compiler internals
+ - [Project Structure](internals/overall-structure.md)
+ of the project
+ - [Backend](internals/backend.md) details on the bytecode backend
+ - [Contexts](internals/contexts.md) details the use of `Context` in the
+ compiler
+ - [Dotty vs Scala2](internals/dotc-scalac.md)
+ - [Higher Kinded Type Scheme](internals/higher-kinded-v2.md)
+ scheme
+ - [Periods](internals/periods.md)
+ - [Type System](internals/type-system.md)