search

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

Removed docs-folder and added npm dev-dependency on yuidocjs #291

Closed SimonSimCity closed 4 years ago

SimonSimCity commented 4 years ago

Reopening https://github.com/Meteor-Community-Packages/meteor-roles/pull/272

mitar commented 4 years ago

Should we be building docs and storing them into some special branch? And then have GitHub pages there?

SimonSimCity commented 4 years ago

Could well do this - I just don't want to update these generated docs every time I update the code.

mitar commented 4 years ago

OK, see https://github.com/Meteor-Community-Packages/meteor-roles/issues/284 for more information.

SimonSimCity commented 4 years ago

Would you keep it in this branch? I wouldn't ... and I've also removed the generated docs from the v3 branch I have. If git has something as assets or if we could push those docs to a separate repo, I'd be on it - I just see it at the wrong place in this repo - or at least on this branch - together with the code.

mitar commented 4 years ago

Yes, generally you have a special branch for static pages, and then you git force push into it when you rebuild docs, so that they do not collect in history.

SimonSimCity commented 4 years ago

Would be nice to get this set up. Please let me know how I could do this. Until then, I'll at least keep all this documentation out of the branches where we do active development on the codebase.

mitar commented 4 years ago

Let's discuss this in #284.