8000 Add anchors in Corelib html index by Villetaneuse · Pull Request #20680 · rocq-prover/rocq · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Add anchors in Corelib html index #20680

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

Merged

Conversation

Villetaneuse
Copy link
Contributor

This is to make it possible to refer to these list items in links (e.g. for #20450).

Not a web person, so there may be better ways to do it.

This is to make it possible to refer to these list items in links
(e.g. for rocq-prover#20450).
@Villetaneuse Villetaneuse requested a review from a team as a code owner May 26, 2025 07:46
@coqbot-app coqbot-app bot added the needs: full CI The latest GitLab pipeline that ran was a light CI. Say "@coqbot run full ci" to get a full CI. label May 26, 2025
Villetaneuse added a commit to Villetaneuse/coq that referenced this pull request May 26, 2025
I don't think the average user cares about other tactics languages when
browsing this part of the tutorial.
Other tactics languages are already mentioned in the "Creating new
tactics" part of the refman.

Add a reference to the Ltac2 part of the Rocq website.

Prerequisite: rocq-prover#20680

Fixes/closes: rocq-prover#20450
@Villetaneuse Villetaneuse added kind: documentation Additions or improvement to documentation. and removed needs: full CI The latest GitLab pipeline that ran was a light CI. Say "@coqbot run full ci" to get a full CI. labels May 26, 2025
@Villetaneuse Villetaneuse added this to the 9.0.1 milestone May 26, 2025
<dt> <b>Init</b>:
<dt> <a id="Init"><b>Init</b></a>:
Copy link
Contributor
@TheoWinterhalter TheoWinterhalter May 26, 2025

Choose a reason for hiding this comment

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

Shouldn't the id be on the dt tag instead? Using an a tag seems wrong to me, those are typically used for links (with a href attribute).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You are probably right. Changed it.

Copy link
Contributor

Choose a reason for hiding this comment

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

making it a link to itself could also be nice
the refman has a thing that appears on hover
refman
but probably more complicated to implement

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What do you prefer, then?

@coqbot-app coqbot-app bot added the needs: full CI The latest GitLab pipeline that ran was a light CI. Say "@coqbot run full ci" to get a full CI. label May 26, 2025
@Villetaneuse Villetaneuse force-pushed the add_anchors_corelib_html branch from 4fb04dd to 7808a16 Compare May 26, 2025 08:24
@Villetaneuse Villetaneuse removed the needs: full CI The latest GitLab pipeline that ran was a light CI. Say "@coqbot run full ci" to get a full CI. label May 26, 2025
@Villetaneuse
Copy link
Contributor Author

Is there an artifact showing the result?

@SkySkimmer
Copy link
Contributor

https://coq.gitlabpages.inria.fr/-/coq/-/jobs/5796031/artifacts/_build/default/doc/corelib/html/index.html#Lists

@Villetaneuse
Copy link
Contributor Author

@@ -9,7 +9,7 @@ through the <tt>Require Import</tt> command.</p>
<p>The core library is composed of the following subdirectories:</p>

<dl>
<dt> <b>Init</b>:
<dt id="Init"> <b>Init</b>:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<dt id="Init"> <b>Init</b>:
<dt id="Init"> <a href="#Init"><b>Init</b></a>:

Copy link
Contributor

Choose a reason for hiding this comment

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

you should do the change for the other headings too

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

@SkySkimmer SkySkimmer self-assigned this Jun 2, 2025
Co-authored-by: Gaëtan Gilbert <gaetan.gilbert@skyskimmer.net>
@coqbot-app coqbot-app bot added the needs: full CI The latest GitLab pipeline that ran was a light CI. Say "@coqbot run full ci" to get a full CI. label Jun 2, 2025
@SkySkimmer SkySkimmer removed the needs: full CI The latest GitLab pipeline that ran was a light CI. Say "@coqbot run full ci" to get a full CI. label Jun 2, 2025
@SkySkimmer
Copy link
Contributor

rendered https://coq.gitlabpages.inria.fr/-/coq/-/jobs/5818948/artifacts/_build/default/doc/corelib/html/index.html

@Villetaneuse Villetaneuse force-pushed the add_anchors_corelib_html branch from 723b2d5 to 536a16a Compare June 2, 2025 12:13
@coqbot-app coqbot-app bot added the needs: full CI The latest GitLab pipeline that ran was a light CI. Say "@coqbot run full ci" to get a full CI. label Jun 2, 2025
@Villetaneuse
Copy link
Contributor Author

Juste added a forgotten '#' somewhere.

@Villetaneuse Villetaneuse removed the needs: full CI The latest GitLab pipeline that ran was a light CI. Say "@coqbot run full ci" to get a full CI. label Jun 3, 2025
@SkySkimmer
Copy link
Contributor

@coqbot merge now

@coqbot-app coqbot-app bot merged commit 91bce98 into rocq-prover:master Jun 4, 2025
7 of 8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind: documentation Additions or improvement to documentation.
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

4 participants
0