rust-lang / rust-lang/rustc-dev-guide

set up live previews for prs

Open
#2,423 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-contributor-devex C-enhancement T-infra WG-rustc-dev-guide
Dominant language
HTML
Stars
1.9k
Forks
612
Avg merge
17h 24m
Merged PRs (30d)
39

Description

we have a static site built from markdown sources. as a reviewer it would be nice to easily view the rendered html for a PR, not just the raw markdown.

not sure who to ask about this - maybe t-infra? maybe we could set up rust-lang.github.io/rustc-dev-guide or something about that?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files, tests, or entry points are named. Start by finding how the Markdown site is rendered and deployed, then determine how pull requests can publish separate previews; done means reviewers can open a rendered HTML preview for each PR.

Written by the indexing model from the issue text.

Assessment

Tech stack
html, markdown
Domain
devops, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.