sublime-fsharp-package icon indicating copy to clipboard operation
sublime-fsharp-package copied to clipboard

document how to use

Open guillermooo opened this issue 10 years ago • 4 comments

  • [ ] tooltips
  • [ ] findecl
  • [ ] show declarations
  • [ ] autocomplete
  • [ ] running script files

guillermooo avatar May 23 '15 20:05 guillermooo

  • [ ] keyboard shortcuts
  • [ ] config

guillermooo avatar Jun 08 '15 18:06 guillermooo

@rojepp Any preference for docs? Read the Docs? The wiki here in this repo? Does F# have any doc generator good enough?

guillermooo avatar Jun 08 '15 18:06 guillermooo

I don't have any strong opinion on this, but it will probably be just manual content instead of generated from anything? Other options:

  • Static site (html + css + images) in gh-pages branch, like VFPT
  • A longer readme, possibly with images, like emacs does

rojepp avatar Jun 08 '15 18:06 rojepp

I'd like to have a landing page too at some point, yes. But I would consider that separately.

IMHO, the readme gets overwhelming quite quickly, but we could start there.

I like RTD and am familiar with Python Sphinx, but we'd need a separate repo and that isn't great.

I guess we'll start in the readme and move to the wiki here and perhaps to RTD if the docs get too long (ha!).

guillermooo avatar Jun 08 '15 18:06 guillermooo