-
Notifications
You must be signed in to change notification settings - Fork 13
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
Use docfy - no more addon-docs. #355
Conversation
* install docfy * update index page * move around documentation files
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall looks GREAT! Nice work 👏 👏 👏
Shouldn't tests/dummy/public/api-docs/
be added to .gitignore
and only be generated once a new version is deployed? How does the deploy of a new page work at the moment? AFAICT this is done manually using ember deploy
?
We should also update the engines
so we use node > 14
tests/dummy/app/templates/index.hbs
Outdated
<div | ||
class='px-4 py-2 my-6 overflow-hidden bg-gray-100 rounded-md' | ||
> | ||
<code> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could add .select-all
so it's selected in one click...
</li> | ||
</ol> | ||
</div> | ||
</div> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
❤️
e2ab122
to
d8beeb2
Compare
This PR docs moves the addon documentation away from ember-cli-addon-docs and uses docfy.
This overhauls the docs page significantly. Preview:
To still provide meaningful API docs we start to use typedoc. While not being perfect I think that's a reasonable approach to documenting the API of the addon for the time being. We are adding typedocs output into the dummy app's
public
-folder and link up the API-navigation manually. Not super elegant but it gets the job done 🚀)
This PR isn't fully complete yet unfortunately - I still need to setup the github pages deployment.