-
Notifications
You must be signed in to change notification settings - Fork 156
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Start of fsdocs page #1302
base: main
Are you sure you want to change the base?
Start of fsdocs page #1302
Conversation
Hah! I was just staring this myself on my fork! |
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. |
<RepositoryUrl>https://github.com/ionide/FsAutoComplete</RepositoryUrl> | ||
<FsDocsLicenseLink>https://github.com/ionide/FsAutoComplete/blob/main/LICENSE.md</FsDocsLicenseLink> | ||
<FsDocsReleaseNotesLink>https://github.com/ionide/FsAutoComplete/blob/main/CHANGELOG.md</FsDocsReleaseNotesLink> | ||
<PackageProjectUrl>https://ionide.io/Tools/fsac.html</PackageProjectUrl> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
On my fork I was actually a bit irritated at this - this data (at least the RepositoryUrl) should be available in the build already. I dug into it a bit and realized that the RepositoryUrl
is set by the NuGet Pack targets, but it's only done a) for Pack
and b) if the user has a few other sentinel properties set up (which usually are handled by the SDK/SourceLink by default).
So I guess I think that FSharp.Formatting should ideally be able to recognize this pattern and adhere to it, in the absence of that getting fixed/changed at the SDK level?
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 :) |
@baronfel @TheAngryByrd good to go? |
@baronfel in reference to fsprojects/FSharp.Formatting#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