-
Notifications
You must be signed in to change notification settings - Fork 552
Open
Labels
Authoring guideIssues for the authoring guide and style guidelinesIssues for the authoring guide and style guidelinesMetaNon-content issues (procedure, tooling, website, etc.)Non-content issues (procedure, tooling, website, etc.)
Description
I think the authoring guide should have guidelines for linking to external documentation.
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.
- ehuss's preference: Don't ever link to RFCs, PRs, GitHub issues, blog posts, and similar things. However, we inevitably will hit sticky issues where we know something is wrong, and not linking to the relevant issue is withholding useful information.
Metadata
Metadata
Assignees
Labels
Authoring guideIssues for the authoring guide and style guidelinesIssues for the authoring guide and style guidelinesMetaNon-content issues (procedure, tooling, website, etc.)Non-content issues (procedure, tooling, website, etc.)