-
Notifications
You must be signed in to change notification settings - Fork 158
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
String Links 404 #794
Comments
it looks like this has (partially) already been fixed in FSharp.Formatting - the URL generation uses docs.microsoft.com: https://github.dev/fsprojects/FSharp.Formatting/blob/a9ecebc3db319f2a3d07f841755ffc61bbf936df/src/FSharp.Formatting.ApiDocs/GenerateModel.fs#L950. However, this should be updated to use Separately, the https://github.com/fsharp/fsharp-core-docs repo should update to a more recent FSharp.Formatting and republish the docs to get the fix. |
Hi Felix, are you interested in contributing here? |
Possibly! I'm just getting started with F#. When I clone and build the repo, I'm getting an MS Build exception. I'm running: OS: Linux 5.10.0-20-amd64 #1 SMP Debian 5.10.158-2 (2022-12-13) x86_64 GNU/Linux .NET: v 7.0.102 IDE: Version: 1.75.1 Ionide.Ionide-fsharp: v7.4.2 Am I doing anything obviously wrong? |
I think I've gotten past the build issue. I can run the documentation locally. I'm just not sure how I can verify that I've fixed the external documentation link. I see that this Current: When I look through the project it seems like there are half a dozen other references to that URL. Should change all of the instances of |
Thanks for the help!
The fsharp core docs are here https://github.com/fsharp/fsharp-core-docs You’d want to build that repo’s docs using the fsdocs tool built with your PR. You can build those docs following the Build Steps on the readme. The key thing would be to clone the repos as described in the fsharp-core-docs build steps. Then make your proposed changes in the FSharp.Formatting repo and build fsdocs with your proposed changes. Then do
It’ll pop up a browser with the fsharp docs and you can test the URLs. |
I've been able to mostly follow the build steps. I had to run the following to spin up the website:
However, it doesn't seem to pick up any modules in fsharp project. See the docs below: Similarly, clicking on any of the documentation links it just complains that the connection was reset: Any clue what might be causing this? |
Hello @felix-alonso, I just tried these steps on Windows and could view the API docs there.
Yes, I believe so, if possible maybe refactor things a bit so that we use Thanks again for looking into this! |
I just found out that the links to System.String and System.Text.RegularExpressions are actually coming from: So, this would need a fix in |
Looks like these are the correct links:
So the change is something like |
@felix-alonso thanks! I've updated all the links at the compiler side: dotnet/fsharp#14774 |
Does this mean I get to put FSharp core contributor on my resume? 🤣 Thank you! |
@felix-alonso I believe this problem is resolved now. Please confirm. |
It's looking good! Thank you so much! |
Thanks for confirming. |
The links to System.String and System.Text.RegularExpressions are 404'ing on this page:
https://fsharp.github.io/fsharp-core-docs/reference/fsharp-core-stringmodule.html
Seems like the format of the link changed:
https://learn.microsoft.com/en-us/dotnet/api/system.string?view=netcore-3.1
The text was updated successfully, but these errors were encountered: