rust-lang / rust-lang/docs.rs

generate OpenGraph image for pages

Open
#2,861 2 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
1.2k
Forks
232
Avg merge
11h 35m
Merged PRs (30d)
60

Description

see https://github.com/rust-lang/crates.io/pulls?q=is%3Apr+is%3Aclosed+opengraph for the crates.io implementation and their subcrate.

I imagine it's an image to be generated for each crate.

These would then be

example from this crates.io page is this image. I imagine some details might be different.

This needs typst locally installed on the docs.rs server.

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

Start by reviewing the linked crates.io pull requests and the crates_io_og_image subcrate, then compare the hashbrown OpenGraph image example with the desired docs.rs output. Check how typst could be installed on the docs.rs server; the work is complete when each crate has a generated OpenGraph image with the agreed details.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.