Add curation tips / FAQs link to Main PHI-Canto help documentation.

[CuzickA]

Hi @jseager7, I was hoping we could find a method to add some of the completed text for curation tips and FAQ to the main Help documentation.

Currently I have a Google file of notes related to #10. There is still a lot of work to do in this file but I wondered if we could pull out some of the sections to start a file that we can make publicly available and update as required.

I am particularly thinking about how best to provide Help guidance for the new AE requested in https://github.com/PHI-base/config/issues/65. I think the information would be too extensive for the main Help document and would be better placed in curation tips/ FAQ.

[jseager7]

I think the best place for curation tips and FAQ would be as a separate page in the main documentation, assuming there is no more relevant place for it (e.g. tips about phenotype annotation should probably be at the bottom of the page for the relevant annotation type).

If we have extensive information about a particular annotation extension, then I'd suggest making one documentation page per annotation extension where required, and linking to it from the help page for the relevant annotation type.

(Note though that having extensive documentation for an annotation extension might indicate that it's harder to use than it should be: in the case of the alteration in archetype extension, it would probably be a lot more self-evident if it were comprised of three fields that could be entered separately, assisted by autocomplete and so on.)

Probably the fastest way to get this into Canto would be to tidy up the document from Google Docs, convert it to Markdown, and add it to this repository.

[CuzickA]

(Note though that having extensive documentation for an annotation extension might indicate that it's harder to use than it should be: in the case of the alteration in archetype extension, it would probably be a lot more self-evident if it were comprised of three fields that could be entered separately, assisted by autocomplete and so on.)

Would this be a lot of work? It would require 3 'boxes/sections' to enter the data within one AE. In some of the fields the data would have to be free text and data lists are not available for loading. Maybe something to think about in the future once the new AE is up and running.

[CuzickA]

I will create a new Google Doc containing the completed sections for text on curation tips/FAQ. This can then be converted to Markdown and added as an additional link out to the bottom of the main user guide contents page.

We can add to the file as new text becomes ready.

[jseager7]

Would this be a lot of work? It would require 3 'boxes/sections' to enter the data within one AE.

It would probably be a lot of work, so definitely something to think about for the future. I think it would also benefit the gene-for-gene interaction extensions to have something like this.