meteor-roles icon indicating copy to clipboard operation
meteor-roles copied to clipboard

Published 20 hours ago • verified publisher icon Meteor-Community-Packages

Which version should be published on GitHub pages?

Open mitar opened this issue 6 years ago • 3 comments
trafficstars

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?

mitar avatar Oct 03 '19 07:10 mitar

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.

SimonSimCity avatar Nov 14 '19 06:11 SimonSimCity

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.

mitar avatar Nov 14 '19 07:11 mitar

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.

SimonSimCity avatar Feb 04 '20 06:02 SimonSimCity

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

StorytellerCZ avatar Feb 03 '24 19:02 StorytellerCZ