rustc-dev-guide icon indicating copy to clipboard operation
rustc-dev-guide copied to clipboard

Consider removing sections about std/core libraries

Open rylev opened this issue 4 years ago • 5 comments

The library team has a guide for the standard library. We should consider removing some chapters like https://rustc-dev-guide.rust-lang.org/stability.html from the rustc-dev-guide. First we should ensure that the content being removed is already reflected in the library guide.

rylev avatar Jul 01 '21 15:07 rylev

I think we should also merge std-dev-guide into the rust doc directory alongside rustc-dev-guide.

joshtriplett avatar Jul 01 '21 16:07 joshtriplett

Long term I don't think either should be in-tree: https://github.com/rust-lang/rust/pull/81848#issuecomment-787588985. But I guess it makes sense for the std guide to be the same as the rustc guide for now.

jyn514 avatar Jul 01 '21 17:07 jyn514

It looks like those comments were written in reaction to the rather large size of the submodule, which looks to be dominated by a few html files for self profile output. Maybe we should put those files on S3 or otherwise not track them in git? And then the rest could be managed via subtree or similar.

Mark-Simulacrum avatar Jul 01 '21 18:07 Mark-Simulacrum

Well, there's also some overhead to having the repo in both places, either @ehuss has to update the submodule when he updates books or someone needs to be in charge of syncing back and forth. It seems a little silly when there's not much benefit from having it in-tree.

jyn514 avatar Jul 01 '21 18:07 jyn514

On Thu, Jul 01, 2021 at 11:03:55AM -0700, Joshua Nelson wrote:

Well, there's also some overhead to having the repo in both places, either @ehuss has to update the submodule when he updates books or someone needs to be in charge of syncing back and forth. It seems a little silly when there's not much benefit from having it in-tree.

I personally would love to see it just merged as a subtree and maintained in-tree; it documents rustc, so having it in rustc seems sensible.

joshtriplett avatar Jul 02 '21 11:07 joshtriplett