fsprojects / zarchive-sublime-fsharp-package

F# development tools for SublimeText 3
32 stars 7 forks source link

document how to use #18

Open guillermooo opened 9 years ago

guillermooo commented 9 years ago
guillermooo commented 9 years ago
guillermooo commented 9 years ago

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

rojepp commented 9 years ago

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

guillermooo commented 9 years ago

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