documentation icon indicating copy to clipboard operation
documentation copied to clipboard

provide link to expand all docs in a project on single page

Open burritojustice opened this issue 9 years ago • 3 comments

within a project (the ones listed on https://mapzen.com/documentation ) provide a link that expands all subsections into a single page to make it easier to search (via ctrl-f) and to download and save/view locally.

A potentially simple way to generate this would be to concatenate all the markdown files in the hierarchy into a single file and a dedicated view/save all project docs link below

burritojustice avatar Aug 15 '16 19:08 burritojustice

an example: I would like to be able to view all of the Tangram concept overview subsections and syntax header subsections in a single page.

image

burritojustice avatar Aug 15 '16 19:08 burritojustice

Thanks @burritojustice. Pulling together files like this isn't supported with our current tools, so this isn't going to happen soon.

Use cases:

  1. To use Ctrl + F to find a certain term.
  2. To print or save the whole documentation section, especially for offline reading or printing.

We should definitely improve the search experience, which may help with the Ctrl + F case. See #158.

rmglennon avatar Aug 15 '16 20:08 rmglennon

Being able to see all of the subsections at once to be able to quickly go through docs calls to mind something resembling more of a API Reference, no?

kkowalsky avatar Aug 16 '16 18:08 kkowalsky