redux icon indicating copy to clipboard operation
redux copied to clipboard

Try integrating Redux Toolkit and React-Redux docs

Open markerikson opened this issue 5 years ago • 5 comments

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.

markerikson avatar Nov 27 '20 18:11 markerikson

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

timdorr avatar Nov 28 '20 03:11 timdorr

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 https://github.com/reduxjs/redux-toolkit/pull/813 , and we don't want to have those updates live until the release goes out.

markerikson avatar Nov 28 '20 03:11 markerikson

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

nickserv avatar Nov 28 '20 10:11 nickserv

Longer explanation of why things are split over in https://github.com/reduxjs/redux-toolkit/issues/2637

markerikson avatar Nov 25 '22 17:11 markerikson

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.

markerikson avatar Nov 25 '22 18:11 markerikson