mautic / mautic/developer-documentation-new

[DOCS]: Write documentation for Roles, and Permissions component

Open
#276 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation needs-triage
Dominant language
Shell
Stars
19
Forks
48
Avg merge
1d 16h
Merged PRs (30d)
25

Description

Description

This issue is for rewriting the Roles and Permissions documentation during the Mautic migration. The goal is to make the content clearer, better structured, and aligned with the new documentation standards.

What is inaccurate, missing, or confusing
• The current explanation of permission bits lacks clarity and proper examples.
• The permission notation (plugin:bundle:level:permission) is not introduced clearly.
• Steps for creating custom permissions are incomplete and need clearer breakdowns.
• Helper methods (standard, extended, manage permissions) need better explanation.
• Some sections are unstructured and difficult for new developers to follow.
• Formatting and terminology are inconsistent with the new documentation style.

Relevant Documentation URL

https://developer.mautic.org/#how-permissions-work

Are you willing to help us fix this by making a pull request?

Yes

Suggestions (Optional)

No response

Screenshots or Screen Recordings (Optional)

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the current Roles and Permissions page at https://developer.mautic.org/#how-permissions-work and locate its source in the developer-documentation-new repository. Review the permission-bit examples, permission notation, custom-permission steps, and helper-method explanations against the new documentation standards. Done means the content is clearer, consistently formatted, complete, and easier for new developers to follow.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.