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] Refactor documentations #6774

Merged
merged 2 commits into from
Dec 14, 2021
Merged

Conversation

BIGWangYuDong
Copy link
Collaborator

Thanks for your contribution and we appreciate it a lot. The following instructions would make your pull request more healthy and more easily get feedback. If you do not understand some items, don't worry, just make the pull request and seek help from maintainers.

Motivation

Please describe the motivation of this PR and the goal you want to achieve through this PR.

Modification

Please briefly describe what modification is made in this PR.

BC-breaking (Optional)

Does the modification introduce changes that break the backward-compatibility of the downstream repos?
If so, please describe how it breaks the compatibility and how the downstream projects should modify their code to keep compatibility with this PR.

Use cases (Optional)

If this PR introduces a new feature, it is better to list some use cases here, and update the documentation.

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.

@BIGWangYuDong BIGWangYuDong changed the title refactor documentations [Docs] Refactor documentations Dec 13, 2021
@ZwwWayne ZwwWayne merged commit e1fcad9 into open-mmlab:dev-v2.19.1 Dec 14, 2021
ZwwWayne pushed a commit that referenced this pull request Dec 14, 2021
@shinya7y
Copy link
Contributor

Hi @BIGWangYuDong @ZwwWayne,
Any plan to fix links to docs?

@BIGWangYuDong
Copy link
Collaborator Author

Hi @BIGWangYuDong @ZwwWayne, Any plan to fix links to docs?

Hi @shinya7y, seems that we need to fix some error links. If you have time, it is welcome to push a PR

@shinya7y
Copy link
Contributor

Unfortunately I cannot send a PR right away.

@BIGWangYuDong
Copy link
Collaborator Author

Unfortunately I cannot send a PR right away.

Haha, I'll check the links tomorrow.

ZwwWayne pushed a commit that referenced this pull request Dec 15, 2021
@BIGWangYuDong BIGWangYuDong deleted the doc_dir branch March 17, 2022 01:33
ZwwWayne pushed a commit that referenced this pull request Jul 18, 2022
ZwwWayne pushed a commit to ZwwWayne/mmdetection that referenced this pull request Jul 19, 2022
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.

3 participants