Skip to content

manual: resolve linkgit in glossary data for links in tooltips#2144

Open
pzhlkj6612 wants to merge 3 commits intogit:gh-pagesfrom
pzhlkj6612:feat/resolve-glossary-tooltip-linkgit-3
Open

manual: resolve linkgit in glossary data for links in tooltips#2144
pzhlkj6612 wants to merge 3 commits intogit:gh-pagesfrom
pzhlkj6612:feat/resolve-glossary-tooltip-linkgit-3

Conversation

@pzhlkj6612
Copy link
Contributor

Changes

(Copied from the commit message)

  • Construct glossay JSON files by Hugo:
    • Move "#{lang}.json" from "static/js/glossary/" to "external/docs/data/glossary/"
    • Create simple documents to pass the language code at "external/docs/content/js/glossary/#{lang}.html"
    • Create a simple template "layouts/js/glossary/single.json.json"
  • Add two Playwright test cases.
  • CI
    • Forget "static/js/glossary".
    • Do not check absolute URLs in generated glossay JSON. It didn't work before because of escaped double quotes: href=\"/.
  • Skip some files for consistency:
    • external/docs/data/docs.json
    • external/docs/data/glossary/#{lang}.json

Context

Hello!

The "git-foo[1]" links in tooltips are broken. I've fixed it with some help. I use AI, and I've written and tested this for serveral days. I can answer questions.

I have not committed changes in "external/docs/data/docs.json" and "external/docs/data/glossary/#{lang}.json" because:

  • I don't want to make this PR too huge.
  • There are CI workflows to update them later.

Here is a screenshots for comparison:

Screenshot showing new links in the tooltips. These new links point to other docs generated by Git's manual pages

.

After making the changes, commit and push to a named branch in your fork, then open a pull request. If it is a big feature, you might want to start an issue first to make sure it's something that will be accepted.

Sorry. I thought: is it feasible? Then, tried several ways and finally it works and the implementation looks not so ugly to me.

Please review, thank you in advance.

* Construct glossay JSON files by Hugo:
  * Move "#{lang}.json" from "static/js/glossary/" to "external/docs/data/glossary/"
  * Create simple documents to pass the language code at "external/docs/content/js/glossary/#{lang}.html"
  * Create a simple template "layouts/js/glossary/single.json.json"
* Add two Playwright test cases.
* CI
  * Forget "static/js/glossary".
  * Do not check absolute URLs in generated glossay JSON. It didn't work before because of escaped double quotes: `href=\"/`.
* Skip some files for consistency:
  * external/docs/data/docs.json
  * external/docs/data/glossary/#{lang}.json

Assisted-by: Claude Opus 4.6 via Copilot
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Claude <242468646+Claude@users.noreply.github.com>
Co-authored-by: Codex <242516109+Codex@users.noreply.github.com>
Co-authored-by: openai-code-agent[bot] <242516109+Codex@users.noreply.github.com>
Co-authored-by: anthropic-code-agent[bot] <242468646+Claude@users.noreply.github.com>
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Mozi <29089388+pzhlkj6612@users.noreply.github.com>
Signed-off-by: Mozi <29089388+pzhlkj6612@users.noreply.github.com>
@pzhlkj6612
Copy link
Contributor Author

I have not committed changes in "external/docs/data/docs.json" and "external/docs/data/glossary/#{lang}.json" because:

  • I don't want to make this PR too huge.
  • There are CI workflows to update them later.

I've run those two workflows "Synchronize with new Git version (if any)" and "Update translated manual pages", and finally get a lot of changes, where:

  • Synchronize with new Git version (if any): 2 files +15 -15 lines changed
  • Update translated manual pages: 54 files +418 -418 lines changed

https://github.com/git/git-scm.com/blob/c0b7cfc55fe6ad45a46d050cd54e885c69e1f7b9/external/docs/sync/git-html-l10n.sha matches the latest l10n commit: jnavila/git-html-l10n@43e818f. That said, we've forgot to RERUN those two scripts for a while. Now let me merge that two generated commits, and then CI should be green.

pzhlkj6612 added 2 commits March 12, 2026 15:51
Updated via the `update-git-version-and-manual-pages.yml` GitHub workflow.
Updated via the `update-translated-manual-pages.yml` GitHub workflow.
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.

1 participant