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

Online documentation is out of date #430

Closed
kfl opened this issue Oct 21, 2023 · 6 comments
Closed

Online documentation is out of date #430

kfl opened this issue Oct 21, 2023 · 6 comments
Assignees

Comments

@kfl
Copy link

kfl commented Oct 21, 2023

Description

The API reference at http://fsprojects.github.io/FSharpx.Extras/reference/index.html seems to be out of date,

For instance, the last version in the Release Notes at http://fsprojects.github.io/FSharpx.Extras/release-notes.html is 2.2.1 - 29.01.2017.

Similarly, the Prelude module is listed to be part of the FSharpx.Functional namespace at http://fsprojects.github.io/FSharpx.Extras/reference/fsharpx-functional-prelude.html. Where is should have been listed as part of the FSharpx namespace as it has been since the 2.3.1 release.

@bartelink
Copy link
Member

Looks like the release notes have been replaced with GitHub releases
https://github.com/fsprojects/FSharpx.Extras/releases
Normally nuget.org is the best way to get a high level on the versions being used IRL https://www.nuget.org/packages/fsharpx.extras#versions-body-tab

@kfl
Copy link
Author

kfl commented Oct 22, 2023

Sorry, I didn't make myself clear. It is not a big problem that the release notes are old (I know where to find them on github). I merely gave a link to the release notes to point out when the online documentation was last updated. You can get the same information if you look at the gh-pages branch, where you can seem that the online documentation was last updated seven years ago.

However, I think it is sad that online documentation isn't updated, so that it's currently pointing to old (misleading) examples and outdated API documentation. Especially since the docs directory seems to be maintained (and has cleaned up the examples) and that the API documentation is also updated.

@bartelink
Copy link
Member

bartelink commented Oct 22, 2023

👍 I'm just a lurker (and have never added a ref to it personally!)
Ultimately the answer is obviously for somebody to automate the push (repos here have access to GHA)...

@gdziadkiewicz
Copy link
Collaborator

gdziadkiewicz commented Oct 23, 2023

Hi, if I remember correctly, I made an attempt at fixing the docs and releasing it but failed and had to rollback (I don't recall the blocking issue). If you are that somebody, then I can cheer, review the PR and hope for you to be luckier than I was at the previous attempt.

edit: I will give it another try myself - this https://fsprojects.github.io/FSharp.Formatting/upgrade.html looks promising

@gdziadkiewicz gdziadkiewicz self-assigned this Oct 23, 2023
@kfl
Copy link
Author

kfl commented Oct 24, 2023

If you are interested then I recently set up generation of online documentation via fsdocs with GHA: https://github.com/diku-dk/diku-canvas/blob/main/.github/workflows/package_and_docs.yml

Although I'm using the new github-pages deployment method where you are using the gh-pages branch method.

@gdziadkiewicz
Copy link
Collaborator

Hi,

I just fixed the issue that bugged me in the past and published new docs :)

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

No branches or pull requests

3 participants