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

176 revise docs #177

Merged
merged 12 commits into from
Mar 16, 2020
Merged

176 revise docs #177

merged 12 commits into from
Mar 16, 2020

Conversation

wyli
Copy link
Contributor

@wyli wyli commented Mar 15, 2020

Fixes #173; fixes #176 .

Description

documentation updates:

  • revise readme
  • update docs/ folder structure
  • update docs/Makefile commands
  • merge hightlights.md into docs/
  • revise docstrings

Status

Ready

Types of changes

  • Docstrings/Documentation updated

Nic-Ma and others added 3 commits March 13, 2020 22:30
        - update readmet
        - update docs/ structure
        - merged highlights.md
        - update docs/Makefile commands
@wyli wyli mentioned this pull request Mar 15, 2020
4 tasks
@wyli wyli requested review from pdogra89 and Nic-Ma March 15, 2020 13:21
@Nic-Ma
Copy link
Contributor

Nic-Ma commented Mar 15, 2020

I updated the end to end process chart according to review feedback.
Thanks.

@wyli wyli force-pushed the 176-revise-docs branch 2 times, most recently from afcbdb4 to 7eabbb2 Compare March 16, 2020 13:18
Copy link
Contributor

@Nic-Ma Nic-Ma left a comment

Choose a reason for hiding this comment

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

Looks good to me.
Thanks.

@Nic-Ma Nic-Ma merged commit 216298c into master Mar 16, 2020
@wyli wyli deleted the 176-revise-docs branch April 6, 2020 13:36
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.

revise api docs and the docs folder add highlight features to README
2 participants