Closed stsewd closed 2 years ago
This is the case of our own repo https://github.com/readthedocs/readthedocs.org, where we have the docs and dev projects.
Currently, using the action more than once will override the previous comment
https://github.com/readthedocs/readthedocs-preview/blob/1029696f6a69477ff98e50ddb239e649f86ec384/action.yaml#L51
We should make the comment easier to locate, instead of using a plain ---- as separator, we could use a comment as a delimiter of the start/end of the comment. For example:
----
<!-- rtd-preview {project} start --> Content <!-- rtd-preview {project} end -->
That way, the current "separator" would be part of the template itself
--- :books: Documentation preview :books:: {docs-pr-index-url}
I liked the idea of using an HTML comment for this! 👍🏼
This done in c70557245b0ae077da1a8aeef7f259e88f2916f6
I tested it at https://github.com/readthedocs/sphinx-hoverxref/pull/220 and it worked.
This is the case of our own repo https://github.com/readthedocs/readthedocs.org, where we have the docs and dev projects.
Currently, using the action more than once will override the previous comment
https://github.com/readthedocs/readthedocs-preview/blob/1029696f6a69477ff98e50ddb239e649f86ec384/action.yaml#L51
We should make the comment easier to locate, instead of using a plain
----
as separator, we could use a comment as a delimiter of the start/end of the comment. For example:That way, the current "separator" would be part of the template itself