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

add docs for all tutorial #12

Merged
merged 18 commits into from
Jan 20, 2024
Merged

add docs for all tutorial #12

merged 18 commits into from
Jan 20, 2024

Conversation

yxdyc
Copy link
Collaborator

@yxdyc yxdyc commented Jan 17, 2024


name: added the tutorials
about: improving the internal tutorial drafts and update them into the github

Description

[Please describe the background, purpose, changes made, and how to test this PR]
The modifications mainly include term unification, typo fixes, hyper-links update, and re-ordering and simplifying some sections for a better flow. Specific diff can be found in internal yuque.

Checklist

Please check the following items before code is ready to be reviewed.

  • Code has passed all tests
  • Docstrings have been added/updated in Google Style
  • Documentation has been updated
  • Code is ready for review

@yxdyc yxdyc self-assigned this Jan 17, 2024
@yxdyc yxdyc added the documentation Improvements or additions to documentation label Jan 17, 2024
@yxdyc yxdyc requested a review from zhijianma January 18, 2024 02:15
docs/tutorial/102-concepts.md Outdated Show resolved Hide resolved
docs/tutorial/103-example.md Outdated Show resolved Hide resolved
docs/tutorial/104-usecase.md Outdated Show resolved Hide resolved
docs/tutorial/104-usecase.md Outdated Show resolved Hide resolved
docs/tutorial/104-usecase.md Outdated Show resolved Hide resolved
docs/tutorial/105-logging.md Outdated Show resolved Hide resolved
docs/tutorial/202-pipeline.md Outdated Show resolved Hide resolved
docs/tutorial/206-prompt.md Outdated Show resolved Hide resolved
docs/tutorial/207-monitor.md Outdated Show resolved Hide resolved
docs/tutorial/207-monitor.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@pan-x-c pan-x-c left a comment

Choose a reason for hiding this comment

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

  1. Links on the homepage jump to the github. It may be more reasonable to jump to the corresponding page of the sphinx doc
  2. The API document content tree on the homepage is duplicated with the sidebar. Maybe it would be better to hide the API document content tree on the homepage

Copy link
Collaborator

@DavdGao DavdGao left a comment

Choose a reason for hiding this comment

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

please see inline comments

docs/tutorial/103-example.md Outdated Show resolved Hide resolved
docs/tutorial/103-example.md Outdated Show resolved Hide resolved
docs/tutorial/103-example.md Outdated Show resolved Hide resolved
docs/tutorial/102-concepts.md Outdated Show resolved Hide resolved
docs/tutorial/102-concepts.md Outdated Show resolved Hide resolved
docs/tutorial/201-agent.md Outdated Show resolved Hide resolved
docs/tutorial/202-pipeline.md Outdated Show resolved Hide resolved
docs/tutorial/202-pipeline.md Outdated Show resolved Hide resolved
docs/tutorial/202-pipeline.md Outdated Show resolved Hide resolved
docs/tutorial/202-pipeline.md Outdated Show resolved Hide resolved
@yxdyc
Copy link
Collaborator Author

yxdyc commented Jan 19, 2024

  1. Links on the homepage jump to the github. It may be more reasonable to jump to the corresponding page of the sphinx doc
  2. The API document content tree on the homepage is duplicated with the sidebar. Maybe it would be better to hide the API document content tree on the homepage

Done. Please @pan-x-c have a look and check this commit and this commit

Copy link
Collaborator

@pan-x-c pan-x-c left a comment

Choose a reason for hiding this comment

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

LGTM

@yxdyc yxdyc merged commit db91984 into modelscope:main Jan 20, 2024
4 checks passed
rayrayraykk pushed a commit that referenced this pull request Feb 26, 2024
Checkpoint bug fixed and change magic pot to realistic concept
FredericW pushed a commit to FredericW/agentscope that referenced this pull request May 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants