Skip to content

Commit 826471c

Browse files
committed
Renames installation subpage to usage
1 parent b770b9b commit 826471c

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

tests/dummy/app/pods/docs/quickstart/template.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This quickstart guide will get you started with a docs site for your brand new
44
addon. After completion you will have a docs homepage, a docs subpage named
5-
`installation`, an automatically generated API reference and a marketing
5+
`usage`, an automatically generated API reference and a marketing
66
homepage you can use to promote your addon.
77

88
1. **Install Addon Docs.**
@@ -16,7 +16,7 @@ following route definitions to your main route.
1616

1717
{{#docs-snippet name='quickstart-router.js' title='tests/dummy/app/router.js'}}
1818
this.route('docs', function() { // docs homepage (required)
19-
this.route('installation'); // docs subpage
19+
this.route('usage'); // docs subpage
2020
this.route('api', function() { // autogenerated API homepage (required)
2121
this.route('item', { path: '/*path' }); // autogenerated API subpages (required)
2222
});
@@ -32,7 +32,7 @@ all docs pages in your site.
3232

3333
{{#viewer.nav as |nav|}}
3434
{{nav.item 'Introduction' 'docs.index'}}
35-
{{nav.item 'Installation' 'docs.installation'}}
35+
{{nav.item 'Usage' 'docs.usage'}}
3636
{{/viewer.nav}}
3737

3838
{{#viewer.main}}
@@ -50,18 +50,18 @@ all docs pages in your site.
5050
actual documentation for your addon and live in the folder
5151
`tests/dummy/app/templates/docs`. Since Addon Docs supports Markdown out
5252
of the box we will create two `.md` files (one for your docs `index` and one
53-
for the `installation` page).
53+
for the `usage` page).
5454

5555
{{#docs-snippet name='quickstart-markdown-index.md' title='tests/dummy/app/templates/docs/index.md' language='markdown'}}
5656
# Index
5757

5858
This is my new addon, and it rocks!
5959
{{/docs-snippet}}
6060

61-
{{#docs-snippet name='quickstart-markdown-subpage.md' title='tests/dummy/app/templates/docs/installation.md' language='markdown'}}
62-
# Installation
61+
{{#docs-snippet name='quickstart-markdown-subpage.md' title='tests/dummy/app/templates/docs/usage.md' language='markdown'}}
62+
# Usage
6363

64-
So easy to install and configure, sweet!
64+
So easy to use, sweet!
6565
{{/docs-snippet}}
6666

6767
5. **Create your marketing homepage**. Create a new template that will function
@@ -92,7 +92,7 @@ create the associated template.
9292
`localhost:4200/docs` to enjoy your brand new documentation website.
9393

9494
8. **Create more pages.** To add more doc pages simply follow the same steps as
95-
used for the `Installation` page in above instructions:
95+
used for the `Usage` page in above instructions:
9696

9797
- create a docs subroute
9898
- add a navigation item to the `docs` template
@@ -114,3 +114,4 @@ windows.
114114
3. **Optional: better scrolling.** You may want to install
115115
[Ember Router Scroll](https://github.com/dollarshaveclub/ember-router-scroll)
116116
to enable "scroll to top with preserved browser history scroll position".
117+

0 commit comments

Comments
 (0)