component-docs
component-docs copied to clipboard
Advertise existence of this resource in more places
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).
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.
Linking to the book from other repos (maybe in place of the WIT reference) and putting it on bytecodealliance.org seem wise to me.
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?
Adding a
Here's a list of BCA projects that it would likely make sense to link to here from:
- [ ] bytecodealliance/wasmtime (under the Documentation heading?)
- [x] bytecodealliance/wrpc
- [ ] bytecodealliance/wasm-tools (after "working with components", as an alert?)
- [ ] bytecodealliance/wit-bindgen (consider changing at least one link to the book rather than the repo?)
- [x] bytecodealliance/go-modules
- [ ] bytecodealliance/sample-wasi-http-js
- [ ] bytecodealliance/sample-wasi-http-rust
- [ ] bytecodealliance/cargo-component
- [ ] bytecodealliance/ComponentizeJS
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.