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

Fix documentation links everywhere and local doc handling #83

Merged
merged 6 commits into from
Jan 31, 2025

Conversation

mattam82
Copy link
Member

@mattam82 mattam82 commented Jan 29, 2025

@mattam82 mattam82 mentioned this pull request Jan 29, 2025
@mattam82
Copy link
Member Author

Comparison with long names vs short names:
image
image

@Zimmi48
Copy link
Member

Zimmi48 commented Jan 30, 2025

It's really cool to have these links on the release pages!

I think I prefer the short names.

FWIW, some of these links are broken on the Coq 8.20.1 release page. Should they be activated only for Rocq releases?

Also, there is still the issue of what we put in the footer.

@mattam82
Copy link
Member Author

It's really cool to have these links on the release pages!

I think I prefer the short names.

Me too. @tabareau ? @BastienSozeau ?

FWIW, some of these links are broken on the Coq 8.20.1 release page. Should they be activated only for Rocq releases?

Yes, I'll have to fix that.

Also, there is still the issue of what we put in the footer.

image

I would merge Documentation/Standard Library/Reference Manual into a single Documentation link to /docs

@Zimmi48
Copy link
Member

Zimmi48 commented Jan 30, 2025

I would merge Documentation/Standard Library/Reference Manual into a single Documentation link to /docs

Sounds good to me. We should remove the link to Exercises too given how empty this page is.

@mattam82
Copy link
Member Author

Ok, I'll implement that

@mattam82
Copy link
Member Author

Look at staging. I prefered Theories to API for the Corelib and Stdlib, it sounds more appropriate to me.

@mattam82 mattam82 requested review from Zimmi48 and tabareau and removed request for Zimmi48 January 31, 2025 10:16
@Zimmi48
Copy link
Member

Zimmi48 commented Jan 31, 2025

There's an issue with the mobile view of the releases: the buttons do not wrap.

Screen Shot 2025-01-31 at 13 44 25

@Zimmi48
Copy link
Member

Zimmi48 commented Jan 31, 2025

Look at staging. I prefered Theories to API for the Corelib and Stdlib, it sounds more appropriate to me.

Sounds good to me, but it seems that you forgot to do this change on the documentation page.

@mattam82
Copy link
Member Author

Good catch

@mattam82
Copy link
Member Author

I think we can first merge this and fix the mobile view afterwards.

@mattam82 mattam82 merged commit af22105 into coq:main Jan 31, 2025
2 checks passed
@mattam82 mattam82 deleted the fix-doc branch January 31, 2025 15:59
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.

2 participants