Repository navigation
Discuss renaming doc/guides #23315
Description
In #23287 (comment), @Trott wrote:
Also: The whole "things called 'guides' are in two different places and mean subtly different things, and oh yeah the website is generated in this repo over here except for the docs which are generated over here".... If there's some way that information could have been something could have been surfaced naturally, I'd love to hear what it is. Because that stuff is confusing and probably only a few people know it.
Maybe the
guidesdirectory in this repo can be renamed to something that makes it clear they are internal to the project and/or moved out ofdocs?Maybe a bot can comment on any PR that adds a new file to the
docs/guidesletting the user know that these guides are for internal use and if they meant to create something for end users, then they should close this PR and open a new PR over in this other repo?Other ideas?
Activity
gabrielschulhof commentedon Oct 7, 2018
doc/contribution_guides?richardlau commentedon Oct 8, 2018
We could also put a
readme.mdindocs/guidesfor anyone browsing through the GitHub UI?mhdawson commentedon Oct 9, 2018
I like the idea of a bot with auto comments.
Trott commentedon Nov 6, 2018
This conversation seems to have stalled or run its course or something. Feel free to re-open if I'm wrong to close it. And, of course, PRs can also be opened for any desired changes.