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

[doc] [workflow] Update hello and matrix section of the docs and add a workflow to check doc builds #1157

Merged
merged 24 commits into from
Jun 10, 2020
Merged

Conversation

rexwangcc
Copy link
Collaborator

Related issue = #... (if any)

[Click here for the format server]


  • Minor updates to the docs so users know there's ti example command they could run.
  • Add a Github Action on PRs to make sure doc updates don't break the doc build.

@archibate
Copy link
Collaborator

Thank for adding the workflow, just a kind reminder: don't forget to test if paths is working, i.e. if I didn't update doc, it won't trigger doc CI.

@rexwangcc
Copy link
Collaborator Author

To prove the paths directive in the newly added workflow works:

5b77f86 and 8f5f4ea did not trigger the docs build since there were no changes to docs/. 9cee5be triggered the docs build checker workflows since it added changed to docs/.

@rexwangcc rexwangcc marked this pull request as ready for review June 6, 2020 04:08
@rexwangcc rexwangcc changed the title [Doc] [misc] Minor updates to docs [Doc] [misc] Update hello and matrix section of the docs and add a workflow to check doc builds Jun 6, 2020
@archibate archibate changed the title [Doc] [misc] Update hello and matrix section of the docs and add a workflow to check doc builds [doc] [workflow] Update hello and matrix section of the docs and add a workflow to check doc builds Jun 6, 2020
@archibate archibate self-requested a review June 6, 2020 08:01
Copy link
Collaborator

@archibate archibate left a comment

Choose a reason for hiding this comment

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

LGTM + nits.

docs/hello.rst Outdated Show resolved Hide resolved
docs/dev_install.rst Outdated Show resolved Hide resolved
docs/matrix.rst Outdated Show resolved Hide resolved
docs/index.rst Outdated Show resolved Hide resolved
docs/index.rst Outdated Show resolved Hide resolved
docs/utilities.rst Outdated Show resolved Hide resolved
docs/utilities.rst Outdated Show resolved Hide resolved
rexwangcc and others added 7 commits June 7, 2020 17:06
Co-authored-by: 彭于斌 <1931127624@qq.com>
Co-authored-by: 彭于斌 <1931127624@qq.com>
Co-authored-by: 彭于斌 <1931127624@qq.com>
Co-authored-by: 彭于斌 <1931127624@qq.com>
Co-authored-by: 彭于斌 <1931127624@qq.com>
@archibate archibate merged commit 7562943 into taichi-dev:master Jun 10, 2020
@yuanming-hu yuanming-hu mentioned this pull request Jun 10, 2020
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