Skip to content
This repository has been archived by the owner on Mar 12, 2024. It is now read-only.

document how to use #18

Open
5 tasks
guillermooo opened this issue May 23, 2015 · 4 comments
Open
5 tasks

document how to use #18

guillermooo opened this issue May 23, 2015 · 4 comments

Comments

@guillermooo
Copy link
Contributor

  • tooltips
  • findecl
  • show declarations
  • autocomplete
  • running script files
@guillermooo guillermooo changed the title document usage document how to use May 23, 2015
@guillermooo
Copy link
Contributor Author

  • keyboard shortcuts
  • config

@guillermooo
Copy link
Contributor Author

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

@rojepp
Copy link
Contributor

rojepp commented Jun 8, 2015

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

@guillermooo
Copy link
Contributor Author

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!).

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants