feathersjs / feathers

The API and real-time application framework
https://feathersjs.com
MIT License
15.07k stars 752 forks source link

docs: use deep outline for typebox sidebar #2950

Closed marshallswain closed 1 year ago

marshallswain commented 1 year ago

Having the deep outline makes it much easier to navigate the massive TypeBox API. Mobile devices only see a short table of contents, but for larger screens, it’s much easier to see what’s available when the sidebar shows the full tree. Also, there’s so much in the document that it’s easy to get lost. The deep outline solves that.

Screenshot 2022-12-29 at 7 38 37 PM

netlify[bot] commented 1 year ago

Deploy Preview for feathers-dove ready!

Name Link
Latest commit 3a1964b7a75d8d898da7554588903b32b831a9b4
Latest deploy log https://app.netlify.com/sites/feathers-dove/deploys/63ae4f94addc29000848633f
Deploy Preview https://deploy-preview-2950--feathers-dove.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

daffl commented 1 year ago

I think I changed this because it was pushing down important information like the query schema and validator docs. Is there a way to define the level of nesting?

marshallswain commented 1 year ago

@daffl There is a way, but it's broken and puts all levels into a single list without indentation. I think we need to reorder the page to put the types last.

marshallswain commented 1 year ago

@daffl, I've updated the page to put the Types last, so they don't push down other important stuff.

marshallswain commented 1 year ago

I've updated the screenshot.

daffl commented 1 year ago

That works. Thanks!