Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consider removing sections about std/core libraries #1156

Open
rylev opened this issue Jul 1, 2021 · 6 comments
Open

Consider removing sections about std/core libraries #1156

rylev opened this issue Jul 1, 2021 · 6 comments
Labels
A-meta Area: meta, about rustc or rustc-dev-guide itself C-discussion Category: discussion T-libs Relevant to libs team WG-rustc-dev-guide Working group: rustc-dev-guide

Comments

@rylev
Copy link
Member

rylev commented Jul 1, 2021

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.

@joshtriplett
Copy link
Member

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

@jyn514
Copy link
Member

jyn514 commented Jul 1, 2021

Long term I don't think either should be in-tree: rust-lang/rust#81848 (comment). But I guess it makes sense for the std guide to be the same as the rustc guide for now.

@Mark-Simulacrum
Copy link
Member

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.

@jyn514
Copy link
Member

jyn514 commented Jul 1, 2021

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.

@joshtriplett
Copy link
Member

joshtriplett commented Jul 2, 2021 via email

@jieyouxu
Copy link
Member

jieyouxu commented Nov 2, 2024

Triage (Nov 2024): we should probably make both rustc-dev-guide and std-dev-guide into subtrees (managed via josh) in r-l/r so both compiler and libs contributors don't have to submit separate PRs to different repos if it makes more sense to be combined into one r-l/r PR.

cf. rustc-dev-guide discussion in https://rust-lang.zulipchat.com/#narrow/channel/196385-t-compiler.2Fwg-rustc-dev-guide/topic/a.20move.20to.20main.20repo.20.28rust-lang.2Frust.29.

@jieyouxu jieyouxu added WG-rustc-dev-guide Working group: rustc-dev-guide C-discussion Category: discussion A-meta Area: meta, about rustc or rustc-dev-guide itself T-libs Relevant to libs team labels Nov 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-meta Area: meta, about rustc or rustc-dev-guide itself C-discussion Category: discussion T-libs Relevant to libs team WG-rustc-dev-guide Working group: rustc-dev-guide
Projects
None yet
Development

No branches or pull requests

5 participants