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

Try integrating Redux Toolkit and React-Redux docs #3958

Open
markerikson opened this issue Nov 27, 2020 · 5 comments
Open

Try integrating Redux Toolkit and React-Redux docs #3958

markerikson opened this issue Nov 27, 2020 · 5 comments
Labels

Comments

@markerikson
Copy link
Contributor

Currently, the Redux, React-Redux, and RTK docs are split across three different sites.

It would be potentially useful to have all three docs sources available in one site.

Unfortunately, the most obvious way to do this would require converting the three separate repos into a monorepo, and I don't want to do that any time soon.

One suggestion was to try using Git submodules to pull the other two repos in, and then update the Redux docs config to reference some of those pages. Might be worth exploring just to see if it even works.

@timdorr
Copy link
Member

timdorr commented Nov 28, 2020

We could also move the docs into their own repo, separate from each code repo.

@markerikson
Copy link
Contributor Author

Problem there is it makes it really hard to coordinate lib+docs updates.

Like, right now we've got a bunch of docs updates for RTK 1.5 in reduxjs/redux-toolkit#813 , and we don't want to have those updates live until the release goes out.

@nickmccurdy
Copy link
Contributor

That could be a branch. FWIW Testing Library has one site repo and it seems to be working well so far.

@markerikson
Copy link
Contributor Author

Longer explanation of why things are split over in reduxjs/redux-toolkit#2637

@markerikson
Copy link
Contributor Author

markerikson commented Nov 25, 2022

Some discussion with Sebastian Lorber of ways to do this with Docusaurus:

https://twitter.com/sebastienlorber/status/1596190164002693122

Also a comment from the DS Discord:

Yeah you could definitely do it during your build process - there are a few orgs using Docusaurus using this type of build methodology. The build pulls in all the docs into place and then they are built according to your config - probably with a docs plugin-per-lib setup.
[Local dev] is complicated. you'd have to have a local build script that does the same. Git submodules could make it a bit easier.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants