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

Header and footer for new website (rocq-prover.org) integration #87

Merged
merged 3 commits into from
Jan 25, 2025

Conversation

mattam82
Copy link
Member

@mattam82 mattam82 commented Jan 20, 2025

This allows to integrate the generated HTML smoothly into the new rocq-prover.org website.
Fixes coq/coq#19976

@mattam82
Copy link
Member Author

@proux01 This changes the styling but it is not definitive (@BastienSozeau needs to adapt it still). Am I understanding correctly that this won't anyway affect released versions (e.g. 8.20.1) if we break things (visually) by modifying the html.

@Zimmi48
Copy link
Member

Zimmi48 commented Jan 20, 2025

Right, the master branch is only for Rocq 9.0 and future versions.

Comment on lines 5 to +10
</div>
</div>
</div>
</div>

</div>
</main>
Copy link
Member

Choose a reason for hiding this comment

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

This is a bit weird. This means that by default, the produced HTML will not be valid. We have to keep in mind that some people would like to view the doc locally. In this case, it is fine to not have any header / footer, but not to have broken HTML.

Copy link
Member Author

Choose a reason for hiding this comment

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

Copy link
Member

Choose a reason for hiding this comment

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

Ah sorry, I didn't realize that this is closing tags that are opened in the header!

@mattam82
Copy link
Member Author

FTR, it looks like this:
image

@proux01
Copy link
Contributor

proux01 commented Jan 21, 2025

@proux01 This changes the styling but it is not definitive (@BastienSozeau needs to adapt it still). Am I understanding correctly that this won't anyway affect released versions (e.g. 8.20.1) if we break things (visually) by modifying the html.

Indeed, the current stdlib repo is only used for the v9.0 and master branches of coq repo.
Once the current PR merged, this will be deployed once anything is pushed on the v9.0 or master branch of coq repo.
Thus, if you want an easier way to try it, I'd recommend doing it first for Corelib in the coq repo, then you'll just have to copy it here for Stdlib.

@proux01
Copy link
Contributor

proux01 commented Jan 23, 2025

@mattam82 what is the status of this? should it be merged? what about Corelib in the core repo?

@mattam82
Copy link
Member Author

This can be merged already and improved upon afterwards.

@mattam82
Copy link
Member Author

I'll make a PR for Corelib as well

Remove playground option, disabled for now
Restore missing closing tag
@mattam82
Copy link
Member Author

Failures seem unrelated.

@mattam82 mattam82 merged commit 95ea362 into master Jan 25, 2025
227 of 230 checks passed
@mattam82 mattam82 deleted the update-header-footer branch January 25, 2025 10:58
@proux01
Copy link
Contributor

proux01 commented Jan 25, 2025

Thanks

@proux01 proux01 added this to the 9.0 milestone Feb 13, 2025
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

Successfully merging this pull request may close these issues.

Change the theme of the refman and the stdlib
3 participants