Learn Seerah Content Repository

This repository contains the structured content (primarily in Markdown/MDX format) used to generate the LearnSeerah educational resource.

Tip

🚀 New! LearnSeerah CMS is Live Easily contribute without needing GitHub knowledge! 👉 Access the CMS to add/edit Seerah content with a visual editor. All changes are securely committed via GitHub pull requests automatically through API requests.

---

Table of Contents

• Contents

• Contributing

  • 1. Reporting Issues
  • 2. Submitting Changes (Pull Requests)
  • 3. Alternative Submission via Email
  • 4. Branch Management
  • 5. Review Process
  • 6. Content Guidelines

• Code of Conduct

---

Contents

The content within this repository is organized following this structure:

# {lang} : Language code  (e.g., en, ur, ar)
# {year} : Plain CE Year (e.g, 571, 610)
# {id}   : Integer Number of order (e.g, 1, 2)
content/
├── glossary/
│   └── {lang}/
│       └── {term}.mdx
│
├── quiz/
│   └── {lang}/
│       └── {quiz-name}.mdx
│
├── references/
│   └── {lang}/
│       └── {reference}.mdx
│
├── seerah/
│   └── {lang}/
│       └── {section}.mdx
│
└── timeline/
    └── {lang}/
        └── {year}-event-{id}.mdx

Note

File and folder names must follow consistent naming and structure across all languages. And MUST not contain non-ASCII characters nor any spaces and symbols, hyphens(-) can be used.

---

Contributing

We welcome contributions to improve and expand the Seerah content. Please follow these guidelines:

Important

Maintain a respectful and reverent tone when writing about the Prophet Muhammad (ﷺ) and related topics.

1. Reporting Issues

If you find any errors, inconsistencies, or areas for improvement:

• Open a new issue in this repository.
• Clearly describe the problem with references to file/line if applicable.

2. Submitting Changes (Pull Requests)

✅ DO:

• Create a new branch (e.g., feature/new-section-badr, fix/typo-migration).
• Follow existing .mdx examples for structure and style.
• Write clear commit messages and PR titles.
• Submit PRs to the dev branch.

🚫 DO NOT:

• Push directly to dev or production.

3. Alternative Submission via Email (If Facing Difficulties)

You may email your content to:

Address: sultan.zain004@outlook.com Subject: [LearnSeerah] New Content Request

Email Body:

Content Type: {content_type}
Content Name: {content_name}
Content: {your content here}

4. Branch Management

Branches are automatically deleted after merge to keep the repo clean.

5. Review Process

• Your PR will be reviewed and may receive feedback.
• Once approved, it will be merged into production.

6. Content Guidelines

• Accuracy — Base content on reliable Islamic sources.
• Clarity — Keep language simple and clear.
• Respect — Maintain an appropriate tone.
• Citations — Include references where necessary.

---

📜 Code of Conduct

We follow the Contributor Covenant Code of Conduct. Please be kind, inclusive, and constructive in all interactions.

---

Contributors

Thanks to all contributors:

Thank you for supporting the LearnSeerah project!