JanusGraph / JanusGraph/janusgraph

Make documentation mobile-friendly

Open
#903 0 comments 0 reactions 0 assignees View on GitHub
area/docs
Dominant language
Java
Stars
5.8k
Forks
1.2k
Avg merge
13h 53m
Merged PRs (30d)
6

Description

More and more of our page views are coming from mobile devices (phones and tablets)1; yet, the documentation only renders well on a desktop browser, and unreadable on a mobile device — the font is too small, and zooming in makes the page too large for the window, which means lots of scrolling around.

One way to fix this may be to use responsive CSS which would render content appropriately for an arbitrary screen size, whether the user is using a desktop/laptop, tablet, or phone.

Since more and more users are surfing and accessing information via mobile devices, it makes sense for us to fix it to make it easier to discover JanusGraph and learn about it.



1 This is a general trend, but I also have some statistics from my AdWords campaign that I'm running for JanusGraph, and 50+% of impressions and clicks are coming from mobile devices.

Contributor guide

Open the contributing guide

Research direction

No documentation files or tests are named in the issue. Start by locating the documentation site's page and stylesheet entry points, then inspect the current layout on phone, tablet, and desktop widths. Done means documentation text is readable and fits arbitrary screen sizes without excessive zooming or horizontal scrolling.

Written by the indexing model from the issue text.

Assessment

Tech stack
css
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.