Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] English introduction #1189

Conversation

evdcush
Copy link
Contributor

@evdcush evdcush commented Jun 3, 2023

Motivation

"Introduction" is the entry-point for new users to MMEngine and our documentation.
However, while the Chinese documentation has an introduction, the English documentation lacks an introduction and refers readers to the Chinese docs.

This branch provides an English translation of the Chinese "Introduction" document.

Modification

This branch modifies the English docs/en/get_started/introduction.md by providing a translation from the Chinese version (permalink).

BC-breaking (Optional)

N/A

Use cases (Optional)

N/A

Checklist

  1. ✅ Pre-commit or other linting tools are used to fix the potential lint issues.
  2. ✅ The modification is covered by complete unit tests. If not, please add more unit test to ensure the correctness.
  3. ✅ If the modification has potential influence on downstream projects, this PR should be tested with downstream projects, like MMDet or MMCls.
  4. ✅ The documentation has been modified accordingly, like docstring or example tutorials.

@evdcush evdcush marked this pull request as ready for review June 3, 2023 13:38
@evdcush evdcush requested a review from C1rN09 as a code owner June 3, 2023 13:38
@zhouzaida
Copy link
Member

Hi @evdcush , thanks for your contribution. This PR can be merged after resolving the comments above.

@zhouzaida zhouzaida added this to the 0.8.0 milestone Jun 5, 2023
@evdcush
Copy link
Contributor Author

evdcush commented Jun 6, 2023

Hi @evdcush , thanks for your contribution. This PR can be merged after resolving the comments above.

@zhouzaida thank you for your review!
I will push fixes soon.

@evdcush evdcush requested a review from zhouzaida June 6, 2023 10:27
@zhouzaida zhouzaida merged commit eb2dc67 into open-mmlab:main Jun 6, 2023
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants