ember-cli-addon-docs

ember-cli-addon-docs copied to clipboard

Document addon suits/monorepos with independent versions

1

This discussion emerged in slack and I will try to put everything together in this issue: ## Background Open sources projects as well as companies internal projects are sometimes put...

gossi

For now `{{docs-viewer.nav}}` helds the API reference. I propose to decouple this into a separate component: ```hbs {{! /addon/components/docs-viewer/x-api}} {{!-- Autogenerated API docs --}} {{#if (gt project.modules.length 0)}} {{docs-viewer/x-section 'API...

gossi

Possibility to link to a page anchor with {{docs-link}}

5

It would be convenient if it was possible to link directly into an anchor in the api references using {{docs-link}}. Maybe using a syntax like: ```handlebars {{docs-link 'buttonType' 'docs.api.item' 'components/button'...

mriska

Auto-populate router entries and nav list

1

Hey, I've been using ember-cli-addon-docs for a project, it has been great for developing isolated components. Have found that there's a fair amount of boilerplate when adding something to the...

jtkese

Better API doc linking

2

[{@link}](http://usejsdoc.org/tags-inline-link.html) tag renders as plain text in API Reference documentation. For example: ```js /** * My Addon Function * * {@link https://ember-learn.github.io/ember-cli-addon-docs/} * * [ember-cli-addon-docs]{@link https://ember-learn.github.io/ember-cli-addon-docs/} * * {@link https://ember-learn.github.io/ember-cli-addon-docs/|ember-cli-addon-docs}...

scottwernervt

Clean up `name` argument usage in docs-demo component

9

Couple of issues I'm having with the `name` argument for the docs-demo: 1. I get `Attempted to register a view with an id already in use: example-undefined` a lot, because...

pzuraq

Allow ability to configure branch name

4

Currently, the [`{{x-main}}`](https://github.com/ember-learn/ember-cli-addon-docs/blob/master/addon/components/docs-viewer/x-main/component.js#L79-L86) component in the `{{docs-viewer}}` has hard-coded URLs that assume that the main branch of the repo is always `master`. I use `latest` for my repositories, and would...

tim-evans

Public cookbook

6

Awesome addon, this is really going to push the professionalism of Ember addons forward lightyears! One of the things I've always enjoyed using to help colleagues with more complex concepts...

sglanzer

Sorting through APIs using visibility

7

I’ve been helping out on the docs website for `ember-animated` and we’ve ran into a use-case where we would like to enable the users to only see public APIs starting...

Oreoz

Right now the `docs-hero` component assumes that the only use-case for using it in block form is to pass in a custom logo. However, users may want to render additional...

elwayman02