Use docfy - no more addon-docs. #355
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* install docfy * update index page * move around documentation files
7 tasks
pangratz
requested changes
May 20, 2021
There was a problem hiding this comment.
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
pangratz
reviewed
May 20, 2021
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.
We could add .select-all so it's selected in one click...
pangratz
reviewed
May 20, 2021
| </li> | ||
| </ol> | ||
| </div> | ||
| </div> |
pangratz
approved these changes
May 21, 2021
LevelbossMike
force-pushed
the
MIKE/remove-addon-docs
branch
from
e2ab122
to
d8beeb2
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.