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

Update to the Documentation Site #425

Merged
merged 2 commits into from
Dec 9, 2024
Merged

Conversation

mrjazzybread
Copy link
Contributor

Hello

I was analyzing the Gospel documentation website and as I was exploring, I noticed that there was a small discrepancy: we state that the type checker differentiates between terms and formulae when that is not the case anymore. Additionally, there were some outdated node packages which led to security problems. I figured that these two issues were relevant enough that they warranted a small PR to fix them. I also changed the git hub actions to use an updated version of node.

@n-osborne n-osborne added documentation no-changelog-needed This PR does not require a changelog entry labels Nov 4, 2024
Copy link
Contributor

@n-osborne n-osborne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

  • First commit message: Updated -> Update
  • The second commit contains an update of node version while it is about updating the content of the documentation

I haven't investigated the incompatibility reported by the CI when trying to build the documentation.

Apart from that, I obviously agree with the change.

@mrjazzybread
Copy link
Contributor Author

Ok I fixed the issues you pointed out. With regards to incompatibility, I think if you change the node version on the Gospel side it will work.

@n-osborne
Copy link
Contributor

It seems that if you update the .github/workflows/documentation.yml the same way you've changed the .github/workflows/localdoc.yml, it should work. (I couldn't reproduce though).

Regarding 1b15126, it is cleaner to use git rebase in these cases, no need for a merge commit.

@mrjazzybread
Copy link
Contributor Author

Ok, I fixed the merge commit and changed the node version on the github/workflows/documentation.yml file.

@n-osborne
Copy link
Contributor

Excellent! Thank you!

@n-osborne n-osborne merged commit 94a0cf2 into ocaml-gospel:main Dec 9, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation no-changelog-needed This PR does not require a changelog entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants