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.

Sign up for GitHub

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

Jump to bottom

docs: optimize document #673

Merged
merged 1 commit into from
Oct 22, 2021
Merged

docs: optimize document #673

merged 1 commit into from
Oct 22, 2021

Conversation

cndoit18
Copy link
Member

Signed-off-by: cndoit18 [email protected]

Description

Related Issue

Closes: #641

Motivation and Context

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation Update (if none of the other choices apply)

Checklist:

  • Code compiles correctly.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@cndoit18 cndoit18 requested a review from a team as a code owner September 23, 2021 11:13
@cndoit18 cndoit18 changed the title docs(docs): optimize document WIP docs(docs): optimize document Sep 23, 2021
@cndoit18 cndoit18 marked this pull request as draft September 23, 2021 11:14
zzy987
zzy987 previously approved these changes Oct 9, 2021
View reviewed changes
@cndoit18 cndoit18 force-pushed the optimize-document branch 2 times, most recently from af2916a to ae7fb01 Compare October 12, 2021 09:50
@cndoit18 cndoit18 marked this pull request as ready for review October 12, 2021 09:53
@cndoit18 cndoit18 changed the title WIP docs(docs): optimize document docs(docs): optimize document Oct 12, 2021
@cndoit18 cndoit18 requested a review from zzy987 October 12, 2021 09:53
@cndoit18
Copy link
Member Author

cndoit18 commented Oct 12, 2021 •
edited
Loading

我尝试做了一些调整，不太确定是不是符合我们的需求，能帮我review它么，谢谢 😄 @gaius-qi

@gaius-qi gaius-qi changed the title docs(docs): optimize document docs: optimize document Oct 15, 2021
@gaius-qi
Copy link
Member

  1. 索引页面只要索引，下面附加内容删除。
    image

@gaius-qi
Copy link
Member

  1. 目录结构顺序，命名不对。
    image

@gaius-qi
Copy link
Member

  1. 目录结构的文件名，跟目录结构命名应该相同。
    image
    image

@gaius-qi
Copy link
Member

  1. markdown 写完了，github 看一样，不要出现以下情况：
    image

@cndoit18 cndoit18 marked this pull request as draft October 15, 2021 08:51
@cndoit18 cndoit18 force-pushed the optimize-document branch 9 times, most recently from 730ab09 to 00a8670 Compare October 21, 2021 10:20
@cndoit18 cndoit18 marked this pull request as ready for review October 21, 2021 10:21
@cndoit18
docs(en): upgrade docs
62ddba3 
Signed-off-by: cndoit18 <[email protected]>
gaius-qi
gaius-qi approved these changes Oct 22, 2021
View reviewed changes
Copy link
Member

@gaius-qi gaius-qi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jim3ma jim3ma merged commit ad19cfe into dragonflyoss:main Oct 22, 2021
@cndoit18 cndoit18 deleted the optimize-document branch October 22, 2021 03:37
gaius-qi pushed a commit that referenced this pull request Jun 28, 2023
@cndoit18 @gaius-qi
docs(en): upgrade docs (#673)
c849e87 
Signed-off-by: cndoit18 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gaius-qi gaius-qi gaius-qi approved these changes

@jim3ma jim3ma jim3ma approved these changes

@xujihui1985 xujihui1985 Awaiting requested review from xujihui1985

@244372610 244372610 Awaiting requested review from 244372610

@zzy987 zzy987 Awaiting requested review from zzy987

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Optimize document
4 participants
@cndoit18 @gaius-qi @jim3ma @zzy987