HFX2.0 icon indicating copy to clipboard operation
HFX2.0 copied to clipboard

Published 20 hours ago • verified publisher icon xadamxk

Automate Documentation

Open xadamxk opened this issue 6 years ago • 4 comments

Library: JSDoc How to update project wiki via git: https://help.github.com/en/articles/adding-or-editing-wiki-pages

xadamxk avatar Oct 07 '19 15:10 xadamxk

Don't think this is needed anymore unless it would be possible to scrap through all the features and get the name, description, and what page they run on. Do you think that would be worth it to autogenerate a markdown page for all the features? @TyrantKingBen

xadamxk avatar Jul 07 '20 05:07 xadamxk

That could be useful (certainly would spruce up the current README) and should be relatively easy. On a side-note I started adding documentation to the module, but only made it through HFX.Utils.

TyrantKingBen avatar Jul 07 '20 22:07 TyrantKingBen

As far as framework changes go, I think I want to focus on this next. Do you have any recommendations before I go this route? @TyrantKingBen

xadamxk avatar Feb 26 '21 15:02 xadamxk

Not really. You need to mock/fake chrome (global.chrome = undefined suffices), then you can import/require src/Features and generate markdown from that (e.g. the _name, _description, etc.).

TyrantKingBen avatar Feb 26 '21 23:02 TyrantKingBen