hogepodge commented on a change in pull request #10287:
URL: https://github.com/apache/tvm/pull/10287#discussion_r809565678
##########
File path: docs/contribute/document.rst
##########
@@ -233,3 +233,16 @@ Please use sphinx's ``:ref:`` markup to refer to another
location in the same do
----------
You can use :ref:`document-my-section-tag` to refer to My Section.
+
+Documents with Images / Figures
+-------------------------------
+reStructuredText's `figure
<https://docutils.sourceforge.io/docs/ref/rst/directives.html#figure>`_
+and `image
<https://docutils.sourceforge.io/docs/ref/rst/directives.html#image>`_
+elements allow a document to include an image URL.
+
+Image files created for TVM documentation should reside in the
`<https://github.com/tlc-pack/web-data>`_
+repository, while the `.rst` files *using* those images should reside in the
main TVM repostitory
+(`<https://github.com/apache/tvm>`_).
+
+This will require two Github Pull Requests, one for the image files and
another for the `.rst` files.
Review comment:
I would add that the image needs to land first, followed by the document
change. If the document change lands first it could result in a broken image
being published to the documentation sit.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
