stelligent / mutato

Repo formerly known as mu-cdk. A.K.A Mu2. Pronounced: mew-tah-toe
https://stelligent.github.io/mutato/
MIT License
23 stars 2 forks source link

doc - Documentation generation enforce w/eslint (fixes #14 fixes #15) #20

Closed tmillner closed 4 years ago

tmillner commented 4 years ago

Users can run the lint:check script which uses prettier to check for adherence to the recommended styleguide. Taking this a step further, docs:generate will perform a lint (which should pass if the lint:check passes) AND documentation check according to the rules we define in .eslintrc.js. (Additional configuration here).

If that passes, documentation generation is finally performed by typedoc

tmillner commented 4 years ago

@3p3r addressed 1, 2, & 4 6 - this was a booboo due to squashing that commit when rebasing 5 - made the change. The docs folder (now named documentation) will track all files within it. It is not ignoring anything in order to keep the documentation artifacts 3 - not sure I understand the request. We can create a custom documentation index page but that would be customizing the theme at that point. Right now it is using the default theme, and for the index page renders the project README.md inside. I feel it would be ok to keep it like that for MVP, or unless until we have a pipeline to deploy our docs to.

Let me know what you think

3p3r commented 4 years ago

@tmillner 6 - no worries. you can close this PR, make your changes in a different branch and git cherry-pick there. changes in this branch are small enough to make that happen. reference this PR in your new PR. 5 - not exactly what I wanted, the two can co-exist inside the docs folder. your gitignore would look like this:

docs/**/*
!docs/*.md

This way source markdowns are checked in and generated docs will live in the same place as well. all docs inside one folder. your latest commit accidentally checked in your generated docs artifacts. you should revert that.

  1. check in a stub INDEX.md under docs and pass it as --readme to typedoc. you do not need to change the theme
tmillner commented 4 years ago

Carried into #23