Skip to content

Commit 9a6c2c1

Browse files
committed
docs: restructure and use Gitbook style
1 parent 4f1aa36 commit 9a6c2c1

File tree

12 files changed

+38
-52
lines changed

12 files changed

+38
-52
lines changed

.gitbook.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
root: ./docs
22

33
structure:
4-
readme: ../index.md
4+
readme: ./index.md

docs/SUMMARY.md

Lines changed: 20 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,13 @@
11
# Table of contents
22

3-
* [Initial page](../index.md)
4-
* [Getting Started](getting-started/README.md)
5-
* [Installation](getting-started/installation.md)
6-
* [Configuration](getting-started/configuration.md)
7-
* [Working With Ember Classic](legacy/README.md)
8-
* [EmberComponent](legacy/ember-component.md)
9-
* [Mixins](legacy/mixins.md)
10-
* [Computed Properties](legacy/computed-properties.md)
11-
* [EmberObject](legacy/ember-object.md)
12-
* [Legacy Ember Guide](legacy/overview.md)
13-
* [Working With Ember Data](ember-data/README.md)
14-
* [Overview: Ember Data](ember-data/overview.md)
15-
* [Models](ember-data/models.md)
16-
* [cookbook](cookbook/README.md)
17-
* [Overview](cookbook/overview.md)
18-
* [Working with route models](cookbook/working-with-route-models.md)
19-
* [type-defs](type-defs/README.md)
20-
* [Understanding the Package Names](type-defs/package-names.md)
21-
* [Overview](index.md)
22-
* [ts](ts/README.md)
23-
* [Building Addons in TypeScript](ts/with-addons.md)
24-
* [TypeScript and Ember](ts/overview.md)
25-
* [Decorators](ts/decorators.md)
3+
* [Installation](getting-started/installation.md)
4+
* [Configuration](getting-started/configuration.md)
5+
* [TypeScript and Ember](ts/README.md)
266
* [Using TypeScript with Ember effectively](ts/using-ts-effectively.md)
7+
* [Decorators](ts/decorators.md)
278
* [Current limitations](ts/current-limitations.md)
28-
* [Upgrading from 1.x](upgrade-notes.md)
9+
* [Building Addons in TypeScript](ts/with-addons.md)
10+
* [Understanding the Package Names](type-defs/package-names.md)
2911
* [Working With Ember](ember/README.md)
3012
* [Controllers](ember/controllers.md)
3113
* [Services](ember/services.md)
@@ -34,6 +16,19 @@
3416
* [Components](ember/components.md)
3517
* [Helpers](ember/helpers.md)
3618
* [Routes](ember/routes.md)
37-
* [troubleshooting](troubleshooting/README.md)
19+
* [Working With Ember Data](ember-data/README.md)
20+
* [Overview: Ember Data](ember-data/overview.md)
21+
* [Models](ember-data/models.md)
22+
* [cookbook](cookbook/README.md)
23+
* [Overview](cookbook/overview.md)
24+
* [Working with route models](cookbook/working-with-route-models.md)
25+
* [Working With Ember Classic](legacy/README.md)
26+
* [EmberComponent](legacy/ember-component.md)
27+
* [Mixins](legacy/mixins.md)
28+
* [Computed Properties](legacy/computed-properties.md)
29+
* [EmberObject](legacy/ember-object.md)
30+
* [Legacy Ember Guide](legacy/overview.md)
31+
* [Upgrading from 1.x](upgrade-notes.md)
32+
* [Troubleshooting](troubleshooting/README.md)
3833
* [Conflicting Type Dependencies](troubleshooting/conflicting-types.md)
3934

File renamed without changes.

docs/cookbook/README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,10 @@
1-
# cookbook
1+
# Cookbook
2+
3+
This “cookbook” section contains recipes for various scenarios you may encounter while working on your app or addon.
4+
5+
{% hint style="info" %}
6+
Have an idea for an item that should fit here? [Open an issue for it!](https://github.com/typed-ember/ember-cli-typescript/issues/new/choose) We'd love to help you help us make this experience more awesome for everyone.
7+
{% endhint %}
8+
9+
* Working with route models
210

docs/cookbook/overview.md

Lines changed: 0 additions & 10 deletions
This file was deleted.

docs/getting-started/README.md

Lines changed: 0 additions & 2 deletions
This file was deleted.
File renamed without changes.

docs/troubleshooting/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
1-
# troubleshooting
2-
1+
# Troubleshooting

docs/ts/README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,8 @@
1-
# ts
1+
# TypeScript and Ember
2+
3+
This guide covers the common details and "gotchas" of using TypeScript with Ember. Note that we do _not_ cover the use of TypeScript _or_ Ember in general—for those, you should refer to the corresponding documentation:
4+
5+
* [TypeScript docs](https://www.typescriptlang.org/docs/index.html)
6+
* [TypeScript Deep Dive](https://basarat.gitbook.io/typescript/)
7+
* [Ember docs](https://emberjs.com/learn/)
28

docs/ts/overview.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

0 commit comments

Comments
 (0)