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

Convert reference book from a submodule to a subtree #90133

Closed
jyn514 opened this issue Oct 21, 2021 · 2 comments
Closed

Convert reference book from a submodule to a subtree #90133

jyn514 opened this issue Oct 21, 2021 · 2 comments
Labels
A-contributor-roadblock Area: Makes things more difficult for new contributors to rust itself A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools

Comments

@jyn514
Copy link
Member

jyn514 commented Oct 21, 2021

The reference is a submodule, it cannot actually be directly affected from here. This makes it annoying to update the documentation (which is already hard enough to get people to do). If we convert it to a subtree, we'd make it much easier to document language changes.

cc @ehuss since you're in charge of updating the books. I'm not sure who maintains the reference, I guess cc @rust-lang/lang-docs?

Originally posted by @workingjubilee in #85305 (comment)

@jyn514 jyn514 added A-contributor-roadblock Area: Makes things more difficult for new contributors to rust itself A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools labels Oct 21, 2021
@ehuss
Copy link
Contributor

ehuss commented Oct 21, 2021

This was discussed a bit in rust-lang/reference#817. I guess I'm not 100% opposed, but it will mean more work for me, and more difficulty reviewing and maintaining it. I would lean towards not changing it unless the lang team wants to get more involved.

@jyn514
Copy link
Member Author

jyn514 commented Nov 9, 2021

I don't have a clear idea of the tradeoffs here so I'll defer to your experience :)

@jyn514 jyn514 closed this as completed Nov 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-contributor-roadblock Area: Makes things more difficult for new contributors to rust itself A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools
Projects
None yet
Development

No branches or pull requests

2 participants