Stream: cranelift

Topic: website draft for Cranelift

Chris Fallin (Apr 27 2023 at 07:52):

Hi all -- as mentioned in the CL weekly meeting, BA has registered cranelift.dev for Cranelift and I'm putting together a simple site. (For now the domain just redirects to cranelift/ in the GitHub repo.)

I have a draft in cfallin/cranelfit.dev -- it's just a single page with a description of the project and links. Please do let me know what you think! When we've reached consensus, I'll move the repo into the bytecodealliance namespace and we can make this the live site instead.

cc @fitzgen (he/him) @Trevor Elliott @Jamey Sharp @Andrew Brown @Afonso Bordado @Ulrich Weigand @Alexa VanHattum @Alex Crichton @Lin Clark @Till Schneidereit (sorry if I missed any others who might be interested!)

Chris Fallin (Apr 27 2023 at 07:53):

(the main page of content is this markdown file)

Andrew Brown (Apr 27 2023 at 15:33):

Nice! It reads well. I noticed some of the links are missing; do a search for text in brackets maybe?

fitzgen (he/him) (Apr 27 2023 at 16:36):

For users of Cranelift, the [API] documentation

It seems like [API] is missing a link definition

fitzgen (he/him) (Apr 27 2023 at 16:45):

larger compilers such as [LLVM] or [gcc],

same issue here

Jamey Sharp (Apr 27 2023 at 16:55):

I want to specifically check with @Alexa VanHattum whether it's okay to link to the verification paper pre-print from this new site right now, or if we should hold off until peer review or publication or something.

Jamey Sharp (Apr 27 2023 at 17:03):

My only other suggestion is to replace the phrase "Cranelift's 7-year history" with something we won't need to update every year, like "since Cranelift development began in 2016."

Alexa VanHattum (Apr 27 2023 at 17:57):

Yes, linking the preprint as it is here is fine, thanks for checking!

The Markdown page looks good to me modulo the missing links and a few other nits (I didn't actually locally build the site):

• "A Bytecode Alliance project" should either be in some kind of header font or have a period after.
• Might be nice to have a paragraph here on welcoming new contributors, linking to the "good first issue" label, etc.

Chris Fallin (Apr 27 2023 at 22:07):

I've updated based on feedback, thanks!

Chris Fallin (Apr 27 2023 at 22:07):

I'll bring this up at the next Cranelift weekly, and if folks are ok with it there, I'll go ahead and ping the right folks to make it live.

Chris Clark (May 23 2023 at 15:09):

Might I suggest mdbooks as well for this website. Making a single source of truth for documentation in cranelift. You can put it out to a separate repository so it doesn't bloat the wasmtime repo if you prefer that.

Last updated: Nov 22 2024 at 16:03 UTC