From 38aa68c9196153488a15911df0d5b779da478403 Mon Sep 17 00:00:00 2001 From: Jacob Hoffman-Andrews Date: Wed, 10 Jul 2024 15:39:39 -0700 Subject: [PATCH] about: add policy about JavaScript in docs Also, fix heading heading for "Releases" section of about page. --- templates/core/about/index.html | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/templates/core/about/index.html b/templates/core/about/index.html index 91851a299..9a548df94 100644 --- a/templates/core/about/index.html +++ b/templates/core/about/index.html @@ -37,9 +37,24 @@

More about Docs.rs

Version

Currently running Docs.rs version is: {{ docsrs_version() }}

-

Version

+

Builds

Summaries of the documentation build processes are available at /releases/.

+

JavaScript

+

+ 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 + KaTeX), that's allowed, and + will probably work today but may break in the future. +

+ +

+ 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. +

+

Contact

{%- set governance_link = "https://www.rust-lang.org/governance/teams/dev-tools#docs-rs" -%}