Skip to content

meta-issue: what href should one use to refer to RFC's? #360

Closed
@pnkfelix

Description

When I want to write a link to an RFC in a blog post (or in an issue in a repository of Rust code, or in the rust-lang/rust repo, etc), it is not clear if I should link to the issue number for the PR for that RFC, or to the RFC document itself.

The main problem here, to my mind, is that neither of the two options above is obviously correct, at least not until an RFC has reached the "complete" stage. Here is why:

  • The PR for an RFC will often link to the document that lives in the original author's branch. That branch may be deleted once the RFC is accepted.
  • The link to the RFC document itself is not stable, because the RFC moves from the author's branch into "active", and then from "active" to "complete".

(I am not entirely certain what the active/complete directory structure is buying us, to be honest.)

So: What href's should I be using right now? And also, should we perhaps change out conventions here to make one of the above choices "obviously right"? Note that either choice can work, given the appropriate conventions; for example, if we update the description in the PR to always point to a rendered "current' document (i.e. when it goes from "active" to "complete", then you also update the PR description), then the first bullet would be fine. Likewise, if we got rid of the "active"/"complete" directory structure, then the second bullet would be fine.

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions