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

F# library and interactive reference readiness #17199

Closed
2 of 19 tasks
cartermp opened this issue Feb 25, 2020 · 7 comments
Closed
2 of 19 tasks

F# library and interactive reference readiness #17199

cartermp opened this issue Feb 25, 2020 · 7 comments
Labels
doc-enhancement Improve the current content [org][type][category] dotnet-fsharp/svc migration-fixes Indicates issues or PRs that are related to problems caused by the migration from MSDN Pri3 won't fix Issues that were closed as part of automated backlog grooming

Comments

@cartermp
Copy link
Contributor

cartermp commented Feb 25, 2020

The F# library and interactive reference is now merged into a migration branch: #17004

There are many things that need to be fixed up before it can be considered for inclusion into the full F# documentation set. Here are some of them:

  • All snippet references need to be specified correctly in documents
  • File names should be adjusted to be more URL-friendly
  • Titles are simpler/shorter
  • Parameter section uses a table
  • File metadata should be updated (simplified and dates updated)
  • HTML-encoded text should be cleaned up
  • All redundant files (e.g., Abstract classes) are removed
  • All outdated information (Platforms, Version Information) removed
  • All unnecessary info (e.g., "Assembly: FSharp.Core (in FSharp.Core.dll)") removed
  • F# interactive reference is "hooked up" to the main F# TOC
  • F# library reference is "hooked up" to the main F# TOC
  • All links to the old MSDN site should be updated, and all mentions of the reference being incomplete must be updated
  • Make markdownlint happy

Separately, the following need to also be added, but need not block moving the doc set from the migration branch:

@cartermp cartermp added doc-enhancement Improve the current content [org][type][category] 📚 Area - F# Guide migration-fixes Indicates issues or PRs that are related to problems caused by the migration from MSDN labels Feb 25, 2020
@dotnet-bot dotnet-bot added the ⌚ Not Triaged Not triaged label Feb 25, 2020
cartermp added a commit to dotnet/samples that referenced this issue Feb 26, 2020
cartermp added a commit to dotnet/samples that referenced this issue Feb 26, 2020
cartermp added a commit to dotnet/samples that referenced this issue Feb 26, 2020
cartermp added a commit to dotnet/samples that referenced this issue Feb 26, 2020
@mairaw mairaw removed the ⌚ Not Triaged Not triaged label Feb 26, 2020
@aggieben
Copy link

It looks like this is still a good ways out - is there something we could have in the interim with regard to the core library reference, which currently exists nowhere?

@akeeton
Copy link

akeeton commented Mar 24, 2020

@aggieben Yeah, this is really rough. I managed to follow your trail from #17557. I just wanted to see the immutable Map docs :(

@cartermp
Copy link
Contributor Author

Unfortunately I don't know how long this will take. That said, I wasn't aware that the MSDN links were all dead. That shouldn't have ever happened, since internally we agreed to migrate but not immediately redirect until the migration was complete. I'll raise this over email.

@voronoipotato
Copy link

Anyone looking for them in the interim can find them here courtesy of @baronfel .

https://baronfel.github.io/fsharp-core-api-docs/

@baronfel
Copy link
Member

The link to my copy has been changed, there is now a community-owned and hosted version at https://fsharp.github.io/fsharp-core-api-docs/.

In addition, @cartermp has made an aka.ms link for them at https://aka.ms/fsharp-core-reference

@PRMerger8 PRMerger8 added the Pri3 label Nov 11, 2020
@dotnet-bot
Copy link
Contributor

This issue has been closed as part of the issue backlog grooming process outlined in #22351.

That automated process may have closed some issues that should be addressed. If you think this is one of them, reopen it with a comment explaining why. Tag the @dotnet/docs team for visibility.

@dotnet-bot dotnet-bot added the won't fix Issues that were closed as part of automated backlog grooming label Jan 25, 2021
@hickford
Copy link
Contributor

hickford commented Jan 29, 2021

Working 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
doc-enhancement Improve the current content [org][type][category] dotnet-fsharp/svc migration-fixes Indicates issues or PRs that are related to problems caused by the migration from MSDN Pri3 won't fix Issues that were closed as part of automated backlog grooming
Projects
None yet
Development

No branches or pull requests

10 participants