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

Fix doc links #5199

Merged
merged 1 commit into from
Aug 24, 2022
Merged

Fix doc links #5199

merged 1 commit into from
Aug 24, 2022

Conversation

ecbrinkman
Copy link
Contributor

@ecbrinkman ecbrinkman commented Aug 17, 2022

关联的Issues (Related Issues)

This PR updates the broken doc links in the Venus README. Note, one of the links relating to modules doesn't exist anymore, so I defaulted to the main Venus docs link.

改动 (Proposed Changes)

Changes are to the Venus docs links. Primarily the replacement of the world guide and changing that to intro in the URL.

附注 (Additional Info)

自查清单 (Checklist)

在你认为本 PR 满足被审阅的标准之前,需要确保 / Before you mark the PR ready for review, please make sure that:

  • 符合Venus项目管理规范中关于PR的相关标准 / The PR follows the PR standards set out in the Venus project management guidelines
  • 具有清晰明确的commit message / All commits have a clear commit message.
  • 包含相关的的测试用例或者不需要新增测试用例 / This PR has tests for new functionality or change in behaviour or not need to add new tests.
  • 包含相关的的指南以及文档或者不需要新增文档 / This PR has updated usage guidelines and documentation or not need
  • 通过必要的检查项 / All checks are green

@ecbrinkman
Copy link
Contributor Author

The README references modules, but it seems the documentation is using the word components to describe the architecture. Should this README be updated to remove module terminology?

Copy link
Contributor

@Fatman13 Fatman13 left a comment

Choose a reason for hiding this comment

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

LGTM. Thank you very much for the PR!

@Fatman13
Copy link
Contributor

The README references modules, but it seems the documentation is using the word components to describe the architecture. Should this README be updated to remove module terminology?

And yes. We are transitioning from the term "module" to "component" to better reflect their role within Venus system. Thank you for catching that!

@Fatman13
Copy link
Contributor

We will merge this PR first. Please feel free to submit another one regarding the term change. Thank you!

@Fatman13 Fatman13 merged commit 9511b7c into filecoin-project:master Aug 24, 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.

2 participants