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 user guide #876

Merged
merged 21 commits into from
Aug 21, 2022
Merged

Conversation

HuangJiameng
Copy link
Collaborator

No description provided.

@codecov-commenter
Copy link

codecov-commenter commented Aug 16, 2022

Codecov Report

Merging #876 (f86d56b) into devel (2764c96) will increase coverage by 0.12%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##            devel     #876      +/-   ##
==========================================
+ Coverage   38.02%   38.14%   +0.12%     
==========================================
  Files          99       99              
  Lines       17759    17766       +7     
==========================================
+ Hits         6752     6777      +25     
+ Misses      11007    10989      -18     
Impacted Files Coverage Δ
dpgen/generator/arginfo.py 100.00% <0.00%> (+0.72%) ⬆️
dpgen/simplify/arginfo.py 100.00% <0.00%> (+3.44%) ⬆️
dpgen/dispatcher/Dispatcher.py 35.52% <0.00%> (+3.88%) ⬆️
dpgen/arginfo.py 100.00% <0.00%> (+66.66%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@HuangJiameng
Copy link
Collaborator Author

Add a user guide to help the new user get involved and contribute.
HD video is ready now.

doc/user-guide.md Outdated Show resolved Hide resolved
doc/how-to-contribute.md Outdated Show resolved Hide resolved
doc/how-to-contribute.md Outdated Show resolved Hide resolved
doc/how-to-contribute.md Outdated Show resolved Hide resolved
doc/how-to-contribute.md Outdated Show resolved Hide resolved
doc/how-to-contribute.md Outdated Show resolved Hide resolved
doc/how-to-contribute.md Outdated Show resolved Hide resolved
doc/how-to-contribute.md Outdated Show resolved Hide resolved
doc/user-guide.md Outdated Show resolved Hide resolved
doc/user-guide.md Outdated Show resolved Hide resolved
doc/user-guide.md Outdated Show resolved Hide resolved
doc/user-guide.md Outdated Show resolved Hide resolved

If you want to learn more about Machine parameters, please check [docs for dpdispatcher](https://docs.deepmodeling.com/projects/dpdispatcher/en/latest/)

## [Pull requests - How to contribute](./how-to-contribute.html)
Copy link
Member

Choose a reason for hiding this comment

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

emmmm... The link does not work. I will try to find a solution if you fail to resolve it.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I followed answer-1444. The relative link works in Preview but doesn't work in webpage.

Copy link
Member

Choose a reason for hiding this comment

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

I push f86d56b to resolve the issue. You can take a look.

@wanghan-iapcm wanghan-iapcm merged commit 7f87bd5 into deepmodeling:devel Aug 21, 2022
@HuangJiameng HuangJiameng deleted the add_User_Guide branch September 26, 2022 08:22
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.

4 participants