Documentation crosslinking

[mindrones]

Following this conversation I've started a spreadsheet to track down what parts of the API, the tutorial and the examples can eventually be interlinked [1].

Once we'll have figured out all the links we can figure out eventually how to add links in a non-intrusive/usable way in the site, depending on the links volume.

Assigning to myself but please feel free to get onboard and help as this seems quite a bit of work (we can use comments in the spreadsheet for ease of use).

The json files extracted from the site as of now are at [2].

---

These are the sections of the 3 types of doc, each having 2 columns on the right to add correspondences.

If a section in /docs has a correspondence in /tutorial we can add an "x" in the "Tut" column and link it to the correspondent cell under "Tutorial".

For example these cells are linked:

If we'll find sections with multiple links we can add more "x cells", say for example like this:

For ease of use:

• Cmd-K to link it to some target cell
• select the target cell or type in the target cell coordinate (E11)
• save

[1] https://docs.google.com/spreadsheets/d/14bdp_XNm-n9opbymT_F1T7t0j9Edwl8NSK5G9gweiCU/edit#gid=0

[2] https://gist.github.com/mindrones/bac9331855f29476598ed274be330118

[mindrones]

Quick note, updated the spreadsheet link as apparently it was the wrong one (sorry for the noise)

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.