Which version should be published on GitHub pages?

Meteor-Community-Packages / meteor-roles

Authorization package for Meteor, compatible with built-in accounts packages

http://meteor-community-packages.github.io/meteor-roles/

MIT License

921 stars 166 forks source link

Which version should be published on GitHub pages? #284

Closed mitar closed 6 months ago

mitar commented 4 years ago

The package has documentation at:

https://meteor-community-packages.github.io/meteor-roles/

Should we organize it by versions? Where should be the job to build it? GitHub Actions?

SimonSimCity commented 4 years ago

I just need to run yuidocjs and I get the files generated. For me it's just a question of where should it be pushed. If we just have one version, I'd take the latest version - the one on master.

mitar commented 4 years ago

I would suggest we force push things to gh-pages branch, each version into its own sub-directory. We always clone existing branch, regenerate for a particular version, commit-amend, and force push.

SimonSimCity commented 4 years ago

Something I just found in a research:

https://www.npmjs.com/package/jsdoc-to-markdown - creates markdown for JSDocs
https://github.com/thlorenz/wicked - creates markdown for JSDocs and upload it to the GitHub wiki.

StorytellerCZ commented 6 months ago

Closing this as we will re-work the docs entirely for all MCP packages to unify things.