-
Notifications
You must be signed in to change notification settings - Fork 98
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
[WIP] Add jsdoc to project #1758
Conversation
- update minor version of vue - examples of documentation - added command `doc` to package.json - explicitely working only on app/src files Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com>
Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com>
Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com>
Codecov Report
@@ Coverage Diff @@
## develop #1758 +/- ##
==========================================
- Coverage 97.71% 97.7% -0.01%
==========================================
Files 103 102 -1
Lines 2100 2095 -5
Branches 93 93
==========================================
- Hits 2052 2047 -5
Misses 39 39
Partials 9 9
|
Codecov Report
@@ Coverage Diff @@
## develop #1758 +/- ##
==========================================
Coverage ? 95.06%
==========================================
Files ? 121
Lines ? 2977
Branches ? 128
==========================================
Hits ? 2830
Misses ? 137
Partials ? 10
|
}, | ||
|
||
{ path: `/404`, component: common(`404`) }, | ||
{ path: `*`, component: common(`404`) } | ||
{ path: `/404`, component: require(`./components/common/Page404`).default }, |
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.
nice
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.
Do we need to check in all the docs? Do we need some process to generate the docs?
Usually is more convenient to have the doc in the project, to have it more accessible, it can be also be compressed for older versions. We could enforce it on cci of via git hook, as for now the command to update it manually:
|
OK cool, going with it for now. |
don't we need to update the |
good point |
Let's halt the merge until further discussion |
Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com>
Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com>
Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com>
Signed-off-by: Karoly Albert Szabo <szabo.karoly.a@gmail.com>
I closed this one to have a cleaner single commit, just squashed the changes into another branch |
Description:
doc
to package.jsonCloses #1739
Once we are in a presentable state we may link this in the wiki along with our README
❤️ Thank you!
CHANGELOG.md
with issue # and GitHub usernameFiles changed
in the github PR explorer