rust-lang / spec

The Rust specification
Apache License 2.0
103 stars 7 forks source link

Policy: Linking to other documentation #35

Open ehuss opened 8 months ago

ehuss commented 8 months ago

Should there be a policy on what external documentation the spec will link or refer to?

There are some resources that could be useful to typical Rust developers, like TRPL, or other books or guides. However, having lots of links can be noisy.

There are also non-Rust references, which might be relevant (like other standards). But where do you draw the line?

What is the policy for linking to historical information, such as RFCs, PRs, GitHub issues, blog posts, etc? These sources are mostly static and not updated, and thus may provide outdated or incorrect information. However, as historical context they are useful.