Stream: git-cranelift

Topic: cranelift / Issue #1265 Move documentation from readthedo...


view this post on Zulip GitHub (Feb 28 2020 at 23:27):

alexcrichton transferred Issue #1265:

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 docs directory to Rust files such as cranelift-umbrella/src/lib.rs (and remove the sphinx documentation in README.md). Also, as noted in #1264, it occurred to me that perhaps we would also like to update the docs badge to something like:

[![Documentation Status](https://docs.rs/cranelift/badge.svg)](https://docs.rs/cranelift)
````
[![Documentation Status](https://docs.rs/cranelift/badge.svg)](https://docs.rs/cranelift)

~~~

Last updated: Dec 23 2024 at 14:03 UTC