Skip to content
This repository was archived by the owner on Mar 25, 2025. It is now read-only.
This repository was archived by the owner on Mar 25, 2025. It is now read-only.

show README and structured data on flakehub side-by-side #23

@maxheld83

Description

@maxheld83

(this also isn't in the right place, should probably go inside closed-source flakehub repo(s). Apologies for the wrong place).

(I love ❤️ flakehub -- this is just an idle observation; please close if not helpful).

Googling for flakes or just exploring flakehub, I am often somewhat disoriented as to what a flake does when I see just the Usage tab (though it is very cool that it shows how to add the flake right away).

Image

I then have to click over to README to learn more, which adds a tiny bit of friction.
These READMEs will sometimes have conflicting/non-flake installation instructions, which adds yet another tiny bit of friction.

By comparison, I prefer the package managers with a two column layout, where I have the (structured) metadata and free-form README side-by-side.

Using such a layout, with, say Usage and Outputs in the sidebar, with the README in the main bar would solve these frictions.

For example:

Image Image Image

Metadata

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