component-docs icon indicating copy to clipboard operation
component-docs copied to clipboard

Advertise existence of this resource in more places

Open rylev opened this issue 1 year ago • 4 comments

I've received some feedback that the component docs are not discoverable enough. Perhaps we could do a concerted effort of going to other component related BA repos and making sure the link to these docs is visible from the README (and any other place that would make sense).

rylev avatar May 24 '24 13:05 rylev

It's not as high traffic as our repos, but there are ways we could highlight the Component Model Book on bytecodealliance.org, too -- as a News post, include it among our Projects, mention it in the FAQ on the home page, etc. We've discussed this briefly in SIG Documentation and I'd be happy to work with folks on increasing visibility on our website.

disquisitioner avatar May 24 '24 15:05 disquisitioner

Linking to the book from other repos (maybe in place of the WIT reference) and putting it on bytecodealliance.org seem wise to me.

kate-goldenring avatar May 28 '24 14:05 kate-goldenring

Added a link from the example listing into jco that should be merged soon!

Maybe to make this issue more actionable we could make a concrete list of places we'd like to see the book mentioned?

vados-cosmonic avatar Oct 31 '24 08:10 vados-cosmonic

Adding a

Here's a list of BCA projects that it would likely make sense to link to here from:

This is obviously quite the hefty lift (and there are more repos), but going forward we should probably make issues for individual ecosystems/places that we can increase exposure -- i.e. asking someone when they raise a complaint/note the issue where they were looking so we can conserve effort here.

vados-cosmonic avatar May 12 '25 16:05 vados-cosmonic