[GitHub] Juice10 opened a new issue #320: Split docs into pages as opposed to one long page

[GitBox <gi...@apache.org>]

Juice10 opened a new issue #320: Split docs into pages as opposed to one long page
URL: https://github.com/apache/incubator-openwhisk-website/issues/320
 
 
   Currently all the documentation is on one long page. This was fine initially but now the amount of things we are documenting has outgrown our one pager.
   
   We should split the documentation into multiple pages. This is better for SEO and makes it easier for people to link to different pages. Also currently we are using smaller and smaller headers for each sub-section, which is good because it shows visual hierarchy, but we are nesting so deep that the font sizes are getting super close to the normal text size.
   
   I really like the (Apollo docs)[https://www.apollographql.com/docs/react/features/error-handling.html], they have the same issues we have with regards to catering to different types of users, in their case their split is Client, Engine and Server. I think it would be good to borrow some inspiration from them with regards to our own docs.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services