Wasmtime GitHub notifications bot (Mar 21 2020 at 04:48): Wasmtime GitHub notifications bot (Mar 21 2020 at 04:48):sunfishcode commented on Issue #1160:
We've completely migrated off of the readthedocs site now. The content has been migrated to markdown source files in Cranelift's docs directory, and documentation of the instructions is now on docs.rs as part of the API documentation.
Wasmtime GitHub notifications bot (Mar 23 2020 at 16:25):alexcrichton closed Issue #1160:
What is the feature or code improvement you would like to do in Cranelift?
Figure out what to do with https://cranelift.readthedocs.io. At some point (can't remember where), I saw a discussion about moving the documentation to https://docs.rs exclusively. I think this would be a good idea in order to keep documentation up to date, since https://cranelift.readthedocs.io seems to have some gaps.
What is the value of adding this in Cranelift?
Documentation should be complete and ideally in one place.
Do you have an implementation plan, and/or ideas for data structures or algorithms to use?
I believe we would have to distribute the contents of the
docsdirectory to Rust files such ascranelift-umbrella/src/lib.rs(and remove thesphinxdocumentation inREADME.md). Also, as noted in bytecodealliance/cranelift#1264, it occurred to me that perhaps we would also like to update the docs badge to something like:[](https://docs.rs/cranelift) ```` [](https://docs.rs/cranelift) ~~~
Last updated: Dec 23 2024 at 12:05 UTC