Skip to content

Commit 38aa68c

Browse files
jshaGuillaumeGomez
authored andcommitted
about: add policy about JavaScript in docs
Also, fix heading heading for "Releases" section of about page.
1 parent 279a988 commit 38aa68c

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

templates/core/about/index.html

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,24 @@ <h2 id="more-about-docsrs"> <a href="#more-about-docsrs">More about Docs.rs</a>
3737
<h3 id="version"> <a href="#version">Version</a> </h3>
3838
<p>Currently running Docs.rs version is: <strong>{{ docsrs_version() }}</strong></p>
3939

40-
<h3 id="builds"> <a href="#builds">Version</a> </h3>
40+
<h3 id="builds"> <a href="#builds">Builds</a> </h3>
4141
<p>Summaries of the documentation build processes <a href="/releases">are available at /releases/</a>.</p>
4242

43+
<h3 id="javascript"> <a href="#javascript">JavaScript</a> </h3>
44+
<p>
45+
JavaScript in support of documentation is allowed but not guaranteed to work on docs.rs. What that
46+
means: If you write documentation that inlines some JavaScript (like
47+
<a href="https://katex.org/">KaTeX</a>), that's allowed, and
48+
will probably work today but may break in the future.
49+
</p>
50+
51+
<p>
52+
However, it's not allowed to put JavaScript or other content in docs
53+
published on docs.rs for the purpose of tracking visitors. For instance, adding Google Analytics
54+
scripts, tracking pixels, or site verification for services like Google Search Console. Crates
55+
that do this will have the relevant versions removed and may be blocked from docs.rs.
56+
</p>
57+
4358
<h3 id="contact"> <a href="#contact">Contact</a> </h3>
4459
{%- set governance_link = "https://www.rust-lang.org/governance/teams/dev-tools#docs-rs" -%}
4560
<p>

0 commit comments

Comments
 (0)