Docs Need Update

[wadethestealth]

Documentation Changes Needed:

• 1. Move cell information to a more visible location (and maybe multiple locations or redirect with header link)

  • Seems like their is a lot of information regarding cells and how to make them in docs/Usage/NotebookFiles.md, this should be moved somewhere else. Not everyone may be importing and exporting. A good place could be in the "Gettting Started" page.
  • Done by Update Cell Docs #1745

• 2. Update the Troubleshooting Doc with the issues linked and all the different solution types.

  • Issues: atom/hydrogen wont run python  #1684, Python 3 Kernel Issue #1665, Import Error: DLL load failed for a cython __init__ call #1550, DLL Load failed error importing numpy #1517, Issue with Hydrogen and Miniconda #1500, Hydrogen breaks with a Python 3.7 env but works fine with a 3.6 one #1405. The solutions may need to be sorted and then throwaway if they are too complex or have no benefit over another.

• 3. Add a Doc for Hydrogen Settings and what they do.

  • While we do provide a description, sometimes that is not enough and can lead to a lot of confusion. It may be helpful to provide examples of our settings.
  • This stems from the languageMappings setting, which seems to confuse people regularly even our contributors sometimes.

[Purukitto]

If this Issue still needs attention, I'd like to contribute

[aviatesk]

@Purukitto
Thanks for the message !
Yes we DO need the help.

In my opinion, we especially need an update for

1. Move cell information to a more visible location (and maybe multiple locations or redirect with header link)

   • Seems like their is a lot of information regarding cells and how to make them in docs/Usage/NotebookFiles.md, this should be moved somewhere else. Not everyone may be importing and exporting. A good place could be in the "Gettting Started" page.

In addition to the examples @wadethestealth mentioned above, the new documentation for upcoming features like:

• completion descriptions: Enhance autocomplete #1727
• support for vega-3: Update dependency @nteract/transform-vega to v6 #1724
• inspection datatip: WIP: Inspectation datatip #1710
• import results: Import Results #1715

are really welcome.

[Purukitto]

@aviatesk

In my opinion, we especially need an update for

1. Move cell information to a more visible location (and maybe multiple locations or redirect with header link)

   • Seems like their is a lot of information regarding cells and how to make them in docs/Usage/NotebookFiles.md, this should be moved somewhere else. Not everyone may be importing and exporting. A good place could be in the "Gettting Started" page.

I'll start with this then 👍

[aviatesk]

Cool, looking forward to your PR !

xref:

• Implement Markdown Results #1628
• https://nteract.gitbooks.io/hydrogen/docs/Usage/NotebookFiles.html

[Purukitto]

Cool, looking forward to your PR !

Only pushing update in the docs/Usage/NotebookFiles.md file would be enough or parallel changes are needed on some other files?

Also I feel that adding a separate page under usage for Cells should be a good idea

[aviatesk]

Also I feel that adding a separate page under usage for Cells should be a good idea

This sounds better. Maybe adding something like docs/Usage/Cells.md.
Additionally mentioning that in docs/Usage/GettingStarted.md also could be helpful.

[Purukitto]

@aviatesk
I thought of mentioning it in Getting started but later thought better off it. Knowledge about 'Cell Markers' is necessary as such to get started so I didn't find it fitting.
Also the Getting Started page already references "Export" which in turn references "Cells" so it should be fine