Skip to content

[Feature]: Add shields to Catalyst repos #403

@no30bit

Description

@no30bit

Summary

Add shields to the READMEs to organise the links and/or show CI status at a glance

Description

Summary

The majority of Rust and NPM packages utilise shields like these to wrap links.
For example, take a look at how num lists all of its packages as a table of shields with metadata.

To improve developer experience at Catalyst, some of the deeply buried links can be exposed in a similar way.

Description

Example

As a proof of concept below are 3 manual shields.io badges pointing to https://projectcatalyst.io, https://input-output-hk.github.io/catalyst-libs and https://input-output-hk.github.io/catalyst-voices/api/cat-gateway/rust-docs/cat_gateway/index.html. I've styled them arbitrarily.

project-catalyst-landing
catalyst-libs-pages
catalysy-libs-rust-api

And this badge is automatically generated by GitHub and shows "ci.yml" status for catalyst-libs.

catalyst-libs-ci

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationPull requests that update a documentationenhancementNew feature or request

    Projects

    Status

    📋 Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions