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

about: add policy about JavaScript in docs #2549

Merged
merged 1 commit into from
Jul 11, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion templates/core/about/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,24 @@ <h2 id="more-about-docsrs"> <a href="#more-about-docsrs">More about Docs.rs</a>
<h3 id="version"> <a href="#version">Version</a> </h3>
<p>Currently running Docs.rs version is: <strong>{{ docsrs_version() }}</strong></p>

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

<h3 id="javascript"> <a href="#javascript">JavaScript</a> </h3>
<p>
JavaScript in support of documentation is allowed but not guaranteed to work on docs.rs. What that
means: If you write documentation that inlines some JavaScript (like
<a href="https://katex.org/">KaTeX</a>), that's allowed, and
will probably work today but may break in the future.
</p>

<p>
However, it's not allowed to put JavaScript or other content in docs
published on docs.rs for the purpose of tracking visitors. For instance, adding Google Analytics
scripts, tracking pixels, or site verification for services like Google Search Console. Crates
that do this will have the relevant versions removed and may be blocked from docs.rs.
</p>

<h3 id="contact"> <a href="#contact">Contact</a> </h3>
{%- set governance_link = "https://www.rust-lang.org/governance/teams/dev-tools#docs-rs" -%}
<p>
Expand Down
Loading