Description
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
- catalyst-voices
- Make a badge for root Github Pages link https://input-output-hk.github.io/catalyst-voices.
- Make a badge for direct Rust API reference link https://input-output-hk.github.io/catalyst-voices/api/cat-gateway/rust-docs/cat_gateway/index.html.
- Re-export CI status badge made by GitHub →
- TODO
- catalyst-libs
- Make a badge for root Github Pages link https://input-output-hk.github.io/catalyst-libs.
- Re-export CI status badge made by GitHub →
- TODO
- TODO
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.
And this badge is automatically generated by GitHub and shows "ci.yml" status for catalyst-libs.
Metadata
Metadata
Assignees
Type
Projects
Status