Skip to content

Commit b5858c9

Browse files
authored
Update template.md
1 parent 4136850 commit b5858c9

File tree

1 file changed

+9
-18
lines changed

1 file changed

+9
-18
lines changed

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

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

33
Here's a summary of the patterns we encourage addon authors to follow when documenting their work.
44

5-
{{! FIXME these links don't work with the 'hash' locationType}}
6-
- [Document your addon using its dummy app](#document-your-addon-using-its-dummy-app)
7-
- [Author in Markdown](#author-in-markdown)
8-
- [Design for your audience](#design-for-your-audience)
9-
- [Write versioned guides](#write-versioned-guides)
10-
- [Write versioned API references](#write-versioned-api-references)
11-
- [Deploy your dummy app to GitHub Pages](#deploy-your-dummy-app-to-github-pages)
12-
- [Miscellaneous](#miscellaneous)
13-
14-
## Document your addon using its dummy app
5+
## Using your dummy app as your docs site
156

167
One of the more surprising results to come out of the addon community is the effectiveness of using an addon's dummy application as a full-fledged document site.
178

@@ -25,7 +16,7 @@ Every addon comes with a fully bootstrapped Ember application that can be found
2516

2617
Once you document the new behavior on your doc site, you can now write an acceptance test against it, ensuring (1) that your code is functioning correctly, and (2) that your docs are accurate and up-to-date. Win-win!
2718

28-
## Author in Markdown
19+
## Authoring in Markdown
2920

3021
Authoring your docs pages in Markdown makes it easy for you and your contributors to read and edit your site.
3122

@@ -65,19 +56,19 @@ The large main area is also useful for addons that need more space to illustrate
6556

6657
Typography choices were made primarily for readability. Measure, a typographic term for the number of characters is a line of text, is also an important aspect of readability, so by default most of the layouts you see will be wrapped with an appropriate max-width. To reiterate one of our main goals for the project, we want addon authors to get these patterns for free so they can focus on actually documenting and testing their addons.
6758

68-
## Write versioned guides
59+
## Versioning your docs
6960

70-
Write this...
61+
Addon Docs provides versioned guides out of the box. You can see the version selector in the top-right part of this page. This is provided by the `<docs-header>` component, so your site will get this too assuming you use this component.
7162

72-
## Write versioned API references
63+
If you look at the [`gh-pages`](https://github.com/ember-learn/ember-cli-addon-docs/tree/gh-pages) branch you'll see that this is where versioned builds of your docs app are stored. Versions are created at deploy time and Addon Docs manages this branch of your repository for you.
7364

74-
Autogenerated for you as a route on `DocsViewer.nav`.
65+
New versions are created when a new tag is released. There is also a `master` version updated on every deployed commit, and a `Latest` alias that points to the most recent tag, unless it is force-updated to point to `master`.
7566

76-
Write this...
67+
See the next section on {{docs-link 'deploy guides' 'docs.deploying'}} for more information about deploys.
7768

78-
## Deploy your dummy app to GitHub Pages
69+
## Hosting on GitHub Pages
7970

80-
We suggest deploying your dummy app to GitHub Pages, as it's a simple place available to every GitHub project to host your documentation site. Once you have this set up, you can even automate deployment as part of your Travis CI builds.
71+
Addon Docs is built for open-source addons deploying their docs sites to GitHub Pages. Once you have this set up, you can even automate deployment as part of your Travis CI builds.
8172

8273
For more details, see the {{docs-link 'Deploying' 'docs.deploying'}} section of the guides.
8374

0 commit comments

Comments
 (0)