Skip to content

Stop storing and rendering readmes #735

Open

Description

One of the features of the "crate details page" is showing the crate's README, and this is currently implemented by storing the markdown in the database and rendering it on the fly.

This feature is also present on crates.io though, and crates.io solved this by pre-rendering the READMEs in HTML and storing them on the CDN:

https://static.crates.io/readmes/{name}/{name}-{version}.html

We could reduce duplication by fetching that URL server side when the user requests the page, defaulting to the crate's description if the readme is missing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

    Labels

    A-frontendArea: Web frontendE-mediumEffort: This requires a fair amount of workP-lowLow priority issues

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions