Contributing to Docs

---

Contributing to Docs

Help improve Macro's documentation.

Why Contribute

• Help users understand privacy features

• Improve developer integration guides

• Fix errors and outdated information

• Translate docs to other languages

How to Contribute

Report Issues

Found an error or unclear section?

Submit an issue:

• Go to github.com/macrobrowser/docs

• Click "Issues" then "New Issue"

• Describe the problem

• Suggest improvements

Suggest Improvements

Have ideas for better explanations?

Start a discussion:

• Go to Discussions tab

• Propose your idea

• Get community feedback

Submit Changes

Ready to edit docs directly?

Fork and pull request:

1. Fork the docs repository

2. Clone your fork locally

3. Create a new branch

4. Make your changes

5. Test your changes

6. Submit a pull request

git clone https://github.com/YOUR-USERNAME/macro-docs
cd macro-docs
git checkout -b improve-signing-sandbox-docs
# Make your edits
git add .
git commit -m "Improve signing sandbox explanation"
git push origin improve-signing-sandbox-docs

Then open a pull request on GitHub.

Writing Guidelines

Follow these principles:

Clear and Concise

• Short sentences

• Active voice

• Avoid jargon (or explain it)

• One concept per paragraph

Accurate and Tested

• Test all code examples

• Verify technical claims

• Include error handling

• Show expected outputs

Privacy-Focused Tone

• Emphasize privacy benefits

• Explain security implications

• Use "you" to address readers

• Conversational but professional

Testing Changes

Before submitting:

• Preview your changes locally

• Check all links work

• Test code examples

• Run spell checker

• Verify markdown formatting

Questions?

Need help contributing?

Join Telegram or ask in GitHub Discussions.

---