search

ionide / FsAutoComplete

F# language server using Language Server Protocol
Other
385 stars 151 forks source link

Start of fsdocs page #1302

Open nhirschey opened 1 month ago

nhirschey commented 1 month ago

@baronfel in reference to https://github.com/fsprojects/FSharp.Formatting/issues/918 about a page for FsAutoComplete, this is the start of one. I'm just putting this here for reference, though I recognize you may have a deeper issue.

See screenshot from dotnet fsdocs watch --eval --clean. I took the logo from here: https://github.com/ionide/ionide-vscode-fsharp/blob/main/release/images/logo.png

image

baronfel commented 1 month ago

Hah! I was just staring this myself on my fork!

nhirschey commented 1 month ago

Hope it's useful!

There's no "API DOCS" section at the bottom of the left side bar with auto-documented types/members because that only gets built for dlls with an api as you noticed. But you can still build the site and create documentation pages just fine if that's what you're after.

baronfel commented 1 month ago

I'm curious how the lack of API Docs for the FsAutoComplete project will play out - I was thinking of structures like the config DTO specifically might be useful, as well as in dev-focused docs being able to reference specific internal abstractions. At the least though this gets us started generating something that we can iterate on :)