Skip to content

Documentation cleanup #2605

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 30, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 0 additions & 35 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,38 +10,3 @@ The theory behind these constructors is researched in DOT, a calculus for depend

In this documentation you will find information on how to use the Dotty compiler on your machine, navigate through
the code, setup Dotty with your favorite IDE and more!

Contents
-------

* Dotty Language Reference
- [Intersection Types](reference/intersection-types.md)
- [Union Types](reference/union-types.md)
- [Trait Parameters](reference/trait-parameters.md)
- [Enumerations](reference/enums.md)
- [Algebraic Data Types](reference/adts.md)
- [Enum Translation](reference/desugarEnums.md)
- [By-Name Implicits](reference/implicit-by-name-parameters.md)
* Usage
- [Migrating from Scala 2](usage/migrating.md): migration information
- [Dotty projects with sbt](usage/sbt-projects.md): using sbt
- [IDE support for Dotty](usage/ide-support.md)
- [Dotty projects with cbt](usage/cbt-projects.md): using cbt
* 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
- [Working with the Backend](contributing/backend.md): working with the scala backend
* Internals document the compiler internals
- [Syntax Summary](internals/syntax.md): brief analysis of the syntax
- [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 Scala 2](internals/dotc-scalac.md): explaining the differences between Scalac and Dotty
- [Higher Kinded Type Scheme](internals/higher-kinded-v2.md): scheme
- [Periods](internals/periods.md): details on the concepts of runs, phases and periods
- [Type System](internals/type-system.md): details on the type system of Dotty
* Resources
- [Talks](resources/talks.md): presentations of the various aspects of Dotty

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add an optional field to Title named "desc" and then put these descriptions in the sidebar.yml so we don't lose them.

I'll fix the index generation after the flight.

Otherwise LGTM

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think most of the titles are useless anyway, and we can come up with better ones, I'll let you decide if some are worth keeping :).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this case class exists in "DefaultParams.scala" in the doc-tool project

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, fine - merge as is

3 changes: 3 additions & 0 deletions docs/docs/usage/cbt-projects.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@ layout: doc-page
title: "Using Dotty with cbt"
---

**NOTE: cbt support for Dotty is experimental and incomplete (for example,
incremental compilation is not supported), we recommend [using Dotty with sbt](sbt-projects.md) for now.**

cbt comes with built-in Dotty support. Follow the
[cbt tutorial](https://github.com/cvogt/cbt/), then simply extend `Dotty` in the Build class.

Expand Down
43 changes: 0 additions & 43 deletions docs/docs/usage/migrating.md

This file was deleted.