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.

[ Full content available at: 
https://github.com/apache/incubator-openwhisk-website/issues/320 ]
This message was relayed via gitbox.apache.org for [email protected]

Reply via email to