aboutsummaryrefslogtreecommitdiff
path: root/docs/docs
diff options
context:
space:
mode:
authorFelix Mulder <felix.mulder@gmail.com>2016-11-07 15:36:20 +0100
committerFelix Mulder <felix.mulder@gmail.com>2016-11-07 15:57:52 +0100
commitfb0f3ff8c8e5a2e3b906dd9a8815a2d22ca9c38c (patch)
treef99953c897acd0c2fabf75060e1845650547ccac /docs/docs
parent5d590242132b0f38fc04afed2c787dadfd8d6c2f (diff)
downloaddotty-fb0f3ff8c8e5a2e3b906dd9a8815a2d22ca9c38c.tar.gz
dotty-fb0f3ff8c8e5a2e3b906dd9a8815a2d22ca9c38c.tar.bz2
dotty-fb0f3ff8c8e5a2e3b906dd9a8815a2d22ca9c38c.zip
Fix #1674: add search to doc site
Diffstat (limited to 'docs/docs')
-rw-r--r--docs/docs/contributing/eclipse.md5
-rw-r--r--docs/docs/contributing/getting-started.md3
-rw-r--r--docs/docs/contributing/intellij-idea.md3
-rw-r--r--docs/docs/contributing/workflow.md2
-rw-r--r--docs/docs/index.md4
-rw-r--r--docs/docs/internals/backend.md2
-rw-r--r--docs/docs/internals/contexts.md4
-rw-r--r--docs/docs/internals/dotc-scalac.md4
-rw-r--r--docs/docs/internals/overall-structure.md4
-rw-r--r--docs/docs/internals/periods.md5
-rw-r--r--docs/docs/internals/type-system.md3
-rw-r--r--docs/docs/usage/cbt-projects.md4
-rw-r--r--docs/docs/usage/migrating.md3
-rw-r--r--docs/docs/usage/sbt-projects.md4
14 files changed, 10 insertions, 40 deletions
diff --git a/docs/docs/contributing/eclipse.md b/docs/docs/contributing/eclipse.md
index 46301dc42..9afe28355 100644
--- a/docs/docs/contributing/eclipse.md
+++ b/docs/docs/contributing/eclipse.md
@@ -1,11 +1,8 @@
---
layout: default
-title: Eclipse
+title: "Building Dotty with Eclipse"
---
-Building Dotty with Eclipse
-===========================
-
Build setup
-----------
You may need to redo these steps when the build changes.
diff --git a/docs/docs/contributing/getting-started.md b/docs/docs/contributing/getting-started.md
index 92afd02f3..bea5b6962 100644
--- a/docs/docs/contributing/getting-started.md
+++ b/docs/docs/contributing/getting-started.md
@@ -3,9 +3,6 @@ layout: default
title: "Getting Started"
---
-Getting Started
-===============
-
Talks on Dotty
--------------
- [Scala's Road Ahead](https://www.youtube.com/watch?v=GHzWqJKFCk4) by Martin Odersky [\[slides\]](http://www.slideshare.net/Odersky/scala-days-nyc-2016)
diff --git a/docs/docs/contributing/intellij-idea.md b/docs/docs/contributing/intellij-idea.md
index dda04f515..9231f209a 100644
--- a/docs/docs/contributing/intellij-idea.md
+++ b/docs/docs/contributing/intellij-idea.md
@@ -1,9 +1,8 @@
---
layout: default
+title: "Building Dotty with Intellij IDEA"
---
-Building Dotty with Intellij IDEA
-=================================
Dotty compiler support is available in the [Scala plugin nightly] starting
from 2.2.39. You need to install [IDEA 2016.1] to try it.
diff --git a/docs/docs/contributing/workflow.md b/docs/docs/contributing/workflow.md
index e160999d9..a0b9fd528 100644
--- a/docs/docs/contributing/workflow.md
+++ b/docs/docs/contributing/workflow.md
@@ -3,8 +3,6 @@ layout: default
title: "Workflow"
---
-Workflow
-========
This document details common workflow patterns when working with Dotty.
## Compiling files with dotc ##
diff --git a/docs/docs/index.md b/docs/docs/index.md
index 6fc2b2739..699fcecb1 100644
--- a/docs/docs/index.md
+++ b/docs/docs/index.md
@@ -1,10 +1,8 @@
---
layout: default
-title: "Docs"
+title: "Dotty Documentation"
---
-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.
diff --git a/docs/docs/internals/backend.md b/docs/docs/internals/backend.md
index 1fb9bba26..f10cf1e82 100644
--- a/docs/docs/internals/backend.md
+++ b/docs/docs/internals/backend.md
@@ -3,8 +3,6 @@ layout: default
title: "Backend Internals"
---
-Backend Internals
-=================
The code for the backend is split up by functionality and assembled in the
objet `GenBCode`.
diff --git a/docs/docs/internals/contexts.md b/docs/docs/internals/contexts.md
index e2111029c..09cbb40c5 100644
--- a/docs/docs/internals/contexts.md
+++ b/docs/docs/internals/contexts.md
@@ -1,10 +1,8 @@
---
-title: Contexts
layout: default
+title: "Contexts"
---
-Contexts
-========
The `Context` contains the state of the compiler, for example
* `settings`
* `freshNames` (`FreshNameCreator`)
diff --git a/docs/docs/internals/dotc-scalac.md b/docs/docs/internals/dotc-scalac.md
index cf668cbb8..f41f21370 100644
--- a/docs/docs/internals/dotc-scalac.md
+++ b/docs/docs/internals/dotc-scalac.md
@@ -1,10 +1,8 @@
---
layout: default
-title: "Scalac vs Dotty"
+title: "Differences between Scalac and Dotty"
---
-Differences between Scalac and Dotty
-====================================
Overview explanation how symbols, named types and denotations hang together:
[Denotations.scala:22]
diff --git a/docs/docs/internals/overall-structure.md b/docs/docs/internals/overall-structure.md
index 214e47aa5..08d9ebe97 100644
--- a/docs/docs/internals/overall-structure.md
+++ b/docs/docs/internals/overall-structure.md
@@ -1,10 +1,8 @@
---
layout: default
-title: "Project Structure"
+title: "Dotty Overall Structure"
---
-Dotc Overall Structure
-======================
The compiler code is found in package [dotty.tools]. It spans the
following three sub-packages:
diff --git a/docs/docs/internals/periods.md b/docs/docs/internals/periods.md
index fe788915d..bb161b7b8 100644
--- a/docs/docs/internals/periods.md
+++ b/docs/docs/internals/periods.md
@@ -1,11 +1,8 @@
---
layout: default
-title: "Periods"
-toc: true
+title: "Dotc's concept of time"
---
-Dotc's concept of time
-======================
Conceptually, the `dotc` compiler's job is to maintain views of various
artifacts associated with source code at all points in time. But what is
*time* for `dotc`? In fact, it is a combination of compiler runs and compiler
diff --git a/docs/docs/internals/type-system.md b/docs/docs/internals/type-system.md
index 191c107cf..e86e07fd1 100644
--- a/docs/docs/internals/type-system.md
+++ b/docs/docs/internals/type-system.md
@@ -1,9 +1,8 @@
---
layout: default
+title: "Type System"
---
-Type System
-===========
The types are defined in [dotty/tools/dotc/core/Types.scala][1]
## Class diagram ##
diff --git a/docs/docs/usage/cbt-projects.md b/docs/docs/usage/cbt-projects.md
index 1ae25efd5..291813b91 100644
--- a/docs/docs/usage/cbt-projects.md
+++ b/docs/docs/usage/cbt-projects.md
@@ -1,10 +1,8 @@
---
layout: default
-title: "cbt"
+title: "Using Dotty with cbt"
---
-Using Dotty with cbt
-====================
cbt comes with built-in dotty support. Follow the
[cbt tutorial](https://github.com/cvogt/cbt/), then simply extend `Dotty` in the Build class.
diff --git a/docs/docs/usage/migrating.md b/docs/docs/usage/migrating.md
index d835aeea6..eb76571e5 100644
--- a/docs/docs/usage/migrating.md
+++ b/docs/docs/usage/migrating.md
@@ -3,9 +3,6 @@ layout: default
title: "Migrating to Dotty"
---
-Migrating to Dotty
-==================
-
### Minor tweaks ###
* `sym.linkedClassOfClass` => `sym.linkedClass`
* `definitions` => `ctx.definitions`
diff --git a/docs/docs/usage/sbt-projects.md b/docs/docs/usage/sbt-projects.md
index 79418850d..b4eb5136d 100644
--- a/docs/docs/usage/sbt-projects.md
+++ b/docs/docs/usage/sbt-projects.md
@@ -1,10 +1,8 @@
---
layout: default
-title: "sbt"
+title: "Using Dotty with sbt"
---
-Using Dotty with sbt
-====================
It is now possible to use Dotty with sbt thanks to the dotty-bridge project.
There are two alternatives in how to create an sbt project that uses dotty: