mautic / mautic/user-documentation

Create Mautic style guide

Open
#3 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation help wanted
Dominant language
Shell
Stars
22
Forks
76
Avg merge
22h 9m
Merged PRs (30d)
33

Description

Add the documentation on ways a contributor can contribute to Mautic

  • add screenshots where necessary

  • proofread the documentation

  • make changes where necessary

  • add additional information that would be useful

From the old documentation https://docs.mautic.org/en/contributing/style-guide


Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

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

Review the existing Mautic style guide at https://docs.mautic.org/en/contributing/style-guide and identify where the new documentation belongs in this repository. Add the contributor guidance, supplying screenshots and useful information where needed, then proofread it and confirm all checklist items are complete.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.