Skip to content

Develop built-in help manuals for existing packages #25

@alyeffy

Description

@alyeffy

Currently, learning about the features of bioSyntax and what they translate to involves looking through the manual on our site. If we could package this together with the installation, I think users would be a lot more willing to learn it, especially if we could create custom help text within the editor. e.g. with vim we could possibly incorporate the manual into the vim help doc and make it easy to search the doc using help tags like :h bS.

If it is not possible to do something like this for a specific editor, create a pdf infographic to be packaged with the files that's easily available once you install bioSyntax.

OR ALTERNATELY: create a text file version of the manual, and in the installation script, create an alias e.g. bS-help that prints out the file in the terminal.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions