Hyperlinks to navigate between Vignettes?

Open
#5,833 11 comments 1 reaction 1 assignee View on GitHub

@HunterB433 is already working on this.

Since Apr 7, 2026.

Assessment

This issue has not been assessed yet.

Description

documentation translation

While going through the vignettes in a start-to-finish or continuous manner, one thing that may pose a mild inconvenience is navigating amongst the vignettes in order, also given that the statements toward the end of those connected vignettes (.N - 1) mention continuity (as in saying '... in the next vignette ...'), and could do with links to the next one.

Since there are none, the only way for the reader to follow along (as far as I am aware of) is to either navigate back to the wiki page if following that, or back to here if following the documentation hosted on gitlab.io (and then from the 'Vignettes' dropdown, proceed to select the next one, going below one step at a time). This back-and-forth flow can be avoided.

And if not following those two starting points (highly unlikely, but could be possible), the specific order to sequentially follow among the connected vignettes is usually absent in the order they are enlisted by common commands (vignette(package="data.table"), browseVignettes("data.table"), tools::getVignetteInfo("data.table")[,3], etc.), which may be a tad confusing for beginners as to which one to jump to next (admittedly a rare case).

But again, navigating back one page and then hopping to the next one would only work assuming the reader began reading the vignette inside a browser in the first place, as going through the material within an R session (by say using vignette("datatable-intro", package="data.table”) inside RStudio) would invalidate this hyperlink to stay within, and move to the browser instead (perhaps this was a part of the rationale to not link?), although again there would be no direct way to navigate to the next vignette, and in this case even to go back to the 'Getting started' wiki or landing page for the gitlab.io hosted documentation.

Thus, I think it might be beneficial to include hyperlinks for at least transitioning between vignette chapters for user-friendliness.

Dominant language
R
Stars
3.9k
Forks
1.1k
Avg merge
14h 4m
Merged PRs (30d)
4

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Rdatatable/data.table

All issues in Rdatatable/data.table

Similar issues

More R issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.