reactor-core icon indicating copy to clipboard operation
reactor-core copied to clipboard

Consider splitting the Reference Guide into multiple pages and adding dark mode

Open lynch19 opened this issue 2 years ago • 2 comments

Documentation Issue

The documentation page is currently spanned on a single web page - causing a large amount of load time. That is also pretty uncomfortable when reading on phones (when you leave the app and return this can get a mess). Another thing is that the code is wrapped, which is not so phone-friendly in my opinion. I think it's easier to read the docs on the Github website than on the docs page. Another feature request I'd like to have - dark mode.

Improvement Suggestions

I suggest splitting the docs into pages and making them more modular. Using the great Docusaurus can also help with the code readability since it's pretty comfortable there even for phones. And it also has a dark mode

Additional context

An example of good docs in my opinion is the Redux docs. Spring Boot docs are also pretty good.

lynch19 avatar Jun 17 '22 16:06 lynch19

we'll consider it. note this is unlikely to happen soon as we would have to consider the building and hosting infrastructure for this, comparing with what our Spring siblings did, and also because we don't have much bandwidth to effect such large changes to the documentation structure.

simonbasle avatar Jun 20 '22 08:06 simonbasle

if somebody wants to have a try at the splitting of the documentation, go ahead and submit a PR. This is currently not something we have the bandwidth to deal with.

just know that there is an ongoing experiment in Spring, with the goal to come up with a common solution for documentation and especially things like code snippets, splitting the reference guides, navigating the reference guides, etc... we might benefit from that experiment and align with Spring projects on that side later on.

simonbasle avatar Jul 18 '22 12:07 simonbasle