Skip to content

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 Nic-Ma and pdogra89 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 and others added 4 commits March 15, 2020 20:48
@wyli wyli force-pushed the 176-revise-docs branch 2 times, most recently from afcbdb4 to 7eabbb2 Compare March 16, 2020 13:18
@wyli wyli force-pushed the 176-revise-docs branch from 7eabbb2 to ad30fc4 Compare March 16, 2020 13:32
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

3 participants