diff --git a/docs/contribute/document.rst b/docs/contribute/document.rst index 8658c0fea5062..ffd63490ddf42 100644 --- a/docs/contribute/document.rst +++ b/docs/contribute/document.rst @@ -233,3 +233,21 @@ 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 `_ +and `image `_ +elements allow a document to include an image URL. + +Image files created for TVM documentation should reside in the ``_ +repository, while the `.rst` files *using* those images should reside in the main TVM repostitory +(``_). + +This will require two Github Pull Requests, one for the image files and another for the `.rst` files. +Discussion between the contributor and reviewers may be necessary to coordinate the review process. + +*IMPORTANT NOTE:* When using two Pull Requests as described above, please merge the +Pull Request in ``_ *before* merging +the Pull Request in ``_. +This helps ensure that all URL links in TVM's online documentation are valid.