search

webxdc / webxdc_docs

Documentation for Webxdc
https://docs.webxdc.org
11 stars 4 forks source link

More granular navigation and page structure #79

Closed ansuz closed 1 year ago

ansuz commented 1 year ago

Some of the chapters in the docs are quite long, particularly the Webxdc Specification and Tips & Tricks. I propose that we split them up into subchapters. I think this would make the mdbook easier to navigate overall, and it might also improve results in search engines.

The mdbook docs provide an example of how to structure SUMMARY.md with a nested structure to achieve this layout.

If such a change would be welcome I'll submit a PR to migrate to the new structure.

WofWca commented 1 year ago

TBH I think it doesn't really matter, so I'm fine with it. One thing to keep in mind is that some people prefer the docs to be on a signle page for easier search, like, say, https://lodash.com/. But there is a "search" function in mdBook. But not all people are aware of it.

hpk42 commented 1 year ago

80 was refined and now merged, so we have a more granular structure now. thanks @ansuz