moja-global / moja-global/moja_global_docs

Documentation📄: Add MDX Docs in `Writing Documentation` section

Open
#160 1 comment 1 reaction 1 assignee View on GitHub

@Rohitrout416 is already working on this.

Since Feb 22, 2022.

documentation good first issue T = 4 Hours X = Easy
Dominant language
Shell
Stars
35
Forks
64
PR merge metrics
No merged PRs in 30d

Description

What is the current documentation state?

The documentation explains various practices to follow for contribution to Moja global repository. But even though MDX has been used in most of the documents, there is no current explanation on MDX.

Where is this stated?

https://docs.moja.global/en/latest/contributing/code_contribution_best_practices.html#writing-documentation

Why do you want to improve the statement?

Because Most of the documents use .mdx extension, many people especially beginners are confused. So I want to remove the confusion.

Proposed Statement

I will give a proper explanation on MDX by going through various resources.

Additional context.

Please assign this issue to me since I am really interested to work with it.

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.