Skip to content
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

Move and update the F# Core Library Reference to the new docs site #1469

Open
CameronAavik opened this issue May 7, 2019 · 9 comments
Open
Labels

Comments

@CameronAavik
Copy link

Is your feature request related to a problem? Please describe.
Currently the only documentation on how to use the F# Core API can be found on the old docs website here. In addition, this is the site that is referenced on the F# Guide.

The content on this site has been frozen and is not open to receiving updates and fixes. In addition, there is a lot missing from this site and so it is not a very useful reference any more.

Describe the solution you'd like
The content from this site should be migrated somewhere in the new docs site, such as a subcategory under the F# Language Reference or in the .NET API Browser. This option means that the community is able to update all the missing functions and new developers to F# can see examples of how these functions are used.

The source code for F# Core is already very documented, so I would imagine that the majority of these docs could be auto-generated.

I would also be personally willing to contribute to this documentation with example code if I had a place to update it, but at the moment there is nowhere for me to do so.

Describe alternatives you've considered
As mentioned, the F# Core source on Github has good documentation and so people could browse the source code to determine how to use the API (this is how I explore the API today). But it's not a great user experience, it's not very discoverable especially on Google, and it doesn't contain example usages which I find is the most useful part of using the .NET API Browser.

@welcome
Copy link

welcome bot commented May 7, 2019

Thank you for creating the issue! One of our team members will get back to you shortly with additional information.

@ryanmajidi
Copy link
Collaborator

@dend Can you take a look at this issue?

@supernova-eng supernova-eng assigned cartermp and unassigned dend Jul 31, 2019
@cartermp
Copy link

Not sure why I was assigned here. The problem is that the docs API reference can only auto-generate things; otherwise this would have been taken care of long ago.

@aggieben
Copy link

Any prospect for this happening in the near future?

@cartermp cartermp removed their assignment Jan 21, 2020
@baronfel
Copy link

For those that find this issue before it's resolved: I've auto-generated docs for FSharp.Core 4.7.0 and hosted them here: https://baronfel.github.io/fsharp-core-api-docs/.

@cartermp
Copy link

This is in progress: dotnet/docs#17004

@aggieben
Copy link

Still in progress? #2536 (comment)

@baronfel
Copy link

The main tracking issue now seems to be dotnet/docs#17199

@PRMerger8 PRMerger8 added the Pri3 label Apr 2, 2020
@hickford
Copy link

Community docs link https://fsharp.github.io/fsharp-core-docs/

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

No branches or pull requests

8 participants