cranelift

11133 Commits

49 Branches

140 Tags

128 MiB

Tree: 85f0c68008

Commit Graph

Author	SHA1	Message	Date
Alex Crichton	a75f383f96	Improve the `wasmtime` crate's README (#4174 ) * Improve the `wasmtime` crate's README This commit is me finally getting back to #2688 and improving the README of the `wasmtime` crate. Currently we have a [pretty drab README][drab] that doesn't really convey what we want about Wasmtime. While I was doing this I opted to update the feature list of Wasmtime as well in the main README (which is mirrored into the crate readme), namely adding a bullet point for "secure" which I felt was missing relative to how we think about Wasmtime. Naturally there's a lot of ways to paint this shed, so feedback is of course welcome on this! (I'm not the best writer myself) [drab]: https://crates.io/crates/wasmtime/0.37.0 * Expand the "Fast" bullet a bit more * Reference the book from the wasmtime crate * Update more security docs Also merge the sandboxing security page with the main security page to avoid the empty security page.	3 years ago
Till Schneidereit	3b3b126fe2	Refer to BA security policy (#2912 )	4 years ago
Alex Crichton	bf526b62d3	Add book documentation skeleton and auto-publish from CI (#435 ) This commit adds the skeleton of a new set of documentation for `wasmtime` in the existing `docs` directory. This documentation is organized and compiled with [mdbook] which the Rust project uses for most of its own documentation as well. At a previous meeting we brainstormed a rough skeleton of what the documentation in this book would look like, and I've transcribed that here for an example of how this is rendered and how it can be laid out. No actual documentation is written yet. This commit also additionally adds necessary support to auto-publish both this book documentation and API documentation every time a commit is pushed to the `master` branch. All HTML will be automatically pushed to the `gh-pages` branch so long as the CI passes, and this should get deployed to https://cranestation.github.io/wasmtime. I've done a few dry-runs and I think this'll all work, but we'll likely tweak a few things here and there after running this through CI to make sure everything looks just as we'd like. My hope though is that after this lands we can start actually filling out all the documentation and being able to review it as well. [mdbook]: https://crates.io/crates/mdbook	5 years ago

Author

SHA1

Message

Date

Alex Crichton

a75f383f96

Improve the `wasmtime` crate's README (#4174 )

* Improve the `wasmtime` crate's README

This commit is me finally getting back to #2688 and improving the README
of the `wasmtime` crate. Currently we have a [pretty drab README][drab]
that doesn't really convey what we want about Wasmtime.

While I was doing this I opted to update the feature list of Wasmtime as
well in the main README (which is mirrored into the crate readme),
namely adding a bullet point for "secure" which I felt was missing
relative to how we think about Wasmtime.

Naturally there's a lot of ways to paint this shed, so feedback is of
course welcome on this! (I'm not the best writer myself)

[drab]: https://crates.io/crates/wasmtime/0.37.0

* Expand the "Fast" bullet a bit more

* Reference the book from the wasmtime crate

* Update more security docs

Also merge the sandboxing security page with the main security page to
avoid the empty security page.

3 years ago

Till Schneidereit

3b3b126fe2

Refer to BA security policy (#2912 )

4 years ago

Alex Crichton

bf526b62d3

Add book documentation skeleton and auto-publish from CI (#435 )

This commit adds the skeleton of a new set of documentation for
`wasmtime` in the existing `docs` directory. This documentation is
organized and compiled with [mdbook] which the Rust project uses for
most of its own documentation as well. At a previous meeting we
brainstormed a rough skeleton of what the documentation in this book
would look like, and I've transcribed that here for an example of how
this is rendered and how it can be laid out. No actual documentation is
written yet.

This commit also additionally adds necessary support to auto-publish
both this book documentation and API documentation every time a commit
is pushed to the `master` branch. All HTML will be automatically pushed
to the `gh-pages` branch so long as the CI passes, and this should get
deployed to https://cranestation.github.io/wasmtime.

I've done a few dry-runs and I think this'll all work, but we'll likely
tweak a few things here and there after running this through CI to make
sure everything looks just as we'd like. My hope though is that after
this lands we can start actually filling out all the documentation and
being able to review it as well.

[mdbook]: https://crates.io/crates/mdbook

5 years ago

3 Commits (85f0c680081a5c025d8278b43ccf889e23ed1103)