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.

Sign up for GitHub

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

Jump to bottom

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

Closed
lynch19 opened this issue Jun 17, 2022 · 3 comments · Fixed by #3806
Closed

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

lynch19 opened this issue Jun 17, 2022 · 3 comments · Fixed by #3806
Assignees
@pderop
Labels
type/documentation A documentation update
Milestone
3.7.0-M2

Comments

@lynch19
Copy link

lynch19 commented Jun 17, 2022

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.
@reactorbot reactorbot added the ❓need-triage This issue needs triage, hasn't been looked at by a team member yet label Jun 17, 2022
@simonbasle simonbasle changed the title Improve the docs website Consider splitting the Reference Guide into multiple pages and adding dark mode Jun 20, 2022
@simonbasle simonbasle added type/documentation A documentation update status/need-decision This needs a decision from the team and removed ❓need-triage This issue needs triage, hasn't been looked at by a team member yet labels Jun 20, 2022
@simonbasle
Copy link
Member

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 simonbasle added help wanted We need contributions on this and removed status/need-decision This needs a decision from the team labels Jul 18, 2022
@simonbasle
Copy link
Member

simonbasle commented Jul 18, 2022 •
edited

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 simonbasle added this to the 3.5.0 planning milestone Jul 18, 2022
@chemicL chemicL removed the help wanted We need contributions on this label Mar 20, 2024
@chemicL chemicL modified the milestones: 3.5.x Backlog, 3.6.x Backlog Mar 20, 2024
@pderop pderop modified the milestones: 3.6.x Backlog, 3.7.0-M2 May 3, 2024
@pderop pderop mentioned this issue May 3, 2024
Merged
@chemicL
Copy link
Member

chemicL commented May 17, 2024

Thanks to @pderop we now have the documentation in multiple pages and they also include a mode switcher. Check out the snapshot: https://projectreactor.io/docs/core/snapshot/reference/aboutDoc.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pderop pderop

Labels
type/documentation A documentation update
Projects
None yet
Milestone
3.7.0-M2
Development

Successfully merging a pull request may close this issue.

Migrate reference documentation to Antora pderop/reactor-core
5 participants
@pderop @chemicL @simonbasle @reactorbot @lynch19