Skip to content

Commit

Permalink
Add docs to master for easier management
Browse files Browse the repository at this point in the history
  • Loading branch information
StorytellerCZ committed Sep 5, 2024
1 parent b161b7e commit 56bee6e
Show file tree
Hide file tree
Showing 31 changed files with 12,606 additions and 1 deletion.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ smart.lock

.idea
.DS_Store
docs/
node_modules/
.npm/
.coverage/
Expand Down
25 changes: 25 additions & 0 deletions docs/api.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
YUI.add("yuidoc-meta", function(Y) {
Y.YUIDoc = { meta: {
"classes": [
"Roles",
"UIHelpers"
],
"modules": [
"Roles",
"UIHelpers"
],
"allModules": [
{
"displayName": "Roles",
"name": "Roles",
"description": "Provides functions related to user authorization. Compatible with built-in Meteor accounts packages.\n\nRoles are accessible through `Meteor.roles` collection and documents consist of:\n - `_id`: role name\n - `children`: list of subdocuments:\n - `_id`\n\nChildren list elements are subdocuments so that they can be easier extended in the future or by plugins.\n\nRoles can have multiple parents and can be children (subroles) of multiple roles.\n\nExample: `{_id: 'admin', children: [{_id: 'editor'}]}`\n\nThe assignment of a role to a user is stored in a collection, accessible through `RoleAssignmentCollection`.\nIt's documents consist of\n - `_id`: Internal MongoDB id\n - `role`: A role object which got assigned. Usually only contains the `_id` property\n - `user`: A user object, usually only contains the `_id` property\n - `scope`: scope name\n - `inheritedRoles`: A list of all the roles objects inherited by the assigned role."
},
{
"displayName": "UIHelpers",
"name": "UIHelpers",
"description": "Convenience functions for use on client.\n\nNOTE: You must restrict user actions on the server-side; any\nclient-side checks are strictly for convenience and must not be\ntrusted."
}
],
"elements": []
} };
});
Binary file added docs/assets/css/external-small.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/css/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 56bee6e

Please sign in to comment.