Repository navigation
[Docs] Broken and inconsistent links in the development documentation #57
Copy link
Copy link
Open
Labels
Description
Describe the bug, including details regarding any error messages, version, and platform.
A crawl of the development documentation (https://arrow.apache.org/docs/dev/, build 26.0.0.dev290, 3,832 pages, 2026-09-25) found a number of broken and inconsistent links. The crawl checked every <a>, <link>, <img> and <script> target, plus same-site #fragment anchors. It checked apache/arrow GitHub source and edit links against the main tree.
Paths below are relative to https://arrow.apache.org/docs/dev/.
Broken links with a clear fix in the repo
- "Edit on GitHub" is broken on every autogenerated pyarrow API page (830 pages). Pages under
python/generated/link to.../edit/main/docs/source/python/generated/<name>.rst. Autosummary creates those files at build time, and they are not checked in. python/parquet.htmlreturns 404. The Python Parquet docs were split intopython/parquet/without a redirect. The stable URL will break the same way at the next release.developers/continuous_integration/crossbow.htmlhas relative targetsconda-recipes,python-wheelsandlinux-packages, which all 404 (crossbow.rst). The conda recipes were removed fromdev/tasks.developers/python/development.html:`building the project <build_pyarrow>`_is treated as a URL, which 404s. It should be a:ref:.- R vignettes:
r/articles/data_wrangling.htmllinks todevelopers/writing_bindings.html, which was removed.r/articles/developers/binary_features.htmllinks to../../install.html(404). The target should be../install.html.r/articles/developers/setup.htmlhas a stale anchor#step-3-building-arrow.r/articles/install.htmlhas a stale anchorfs.html#s3-and-gcs-support.r/articles/developers/docker.htmllinks to the olddocs/developers/{docker,crossbow}.htmllocations (404).
- Java docs links point to
https://arrow.apache.org/docs/java/(404) frompython/integration/python_java.htmland from the R pkgdown navbar (r/_pkgdown.yml). The Java docs are athttps://arrow.apache.org/java/current/. developers/guide/resources.htmllinks tor/articles/install.html#install-the-nightly-build. That anchor no longer exists, because the content moved toinstall_nightly.html.- C GLib:
c_glib/doc/{arrow-glib,gandiva-glib}.toml.insetdocs_urlfor Parquet GLib to.../c_glib/arrow-parquet-glib/(404). The published path is.../c_glib/parquet-glib/. - Dead external links:
- Numba CUDA docs (
numba.pydata.org/numba-doc/latest/..., 404) - Jaeger
docs/1.21/opentelemetry/(redirects to a 404) - Wikipedia
Quantile_rank(no such article), in therank_quantilefunction doc invector_rank.cc
- Numba CUDA docs (
- Plain
http://links in several pages (ORC/Parquet/Hadoop/Hive/Drill/Impala/Spark, flatbuffers, nanoarrow, jemalloc, doxygen, sphinx, lz4). The oldmail-archives.apache.orgmailing-list archive link should point tolists.apache.org.
Needs investigation or a maintainer decision (not a simple link edit)
- Parts of the dev site appear stale.
c_glib/index.htmlandr/index.htmlareLast-Modified2026-08-12, andc_glib/arrow-glib/index.htmlis 2026-07-21, while the rest of the site is 2026-09-24. As a result,c_glib/index.htmlstill has the old sidebar linking topython/parquet.html. The C GLib and R parts of the nightly dev-docs deploy may not be publishing. - The sidebar/navbar "R" entry (
implementations.rsthidden toctree) points to the stable R docs (https://arrow.apache.org/docs/r), while C++, C GLib and Python stay on dev. A toctree entry can't be a relative non-Sphinx path, so this needs a different approach. - GLib macro pages (
func.DEPRECATED_FOR.htmland others, 7 libraries × 38 pages) link toc_glib/<lib>/version.hon GitHub. That file is generated by meson, and onlyversion.h.inexists in the repo. c_glib/arrow-glib/alias.TimePoint.htmllinks to a non-existentstruct.TimePoint.html, becauseGArrowTimePointis atypedef gint64._modules/index.htmllists 18 Cython modules (pyarrow/lib,_compute,_fs, …) whose viewcode pages don't exist.- The viewcode backlinks in
_modules/pyarrow/compute.htmluse#pyarrow.dataset.<fn>anchors that don't exist, for 7 functions re-exported inpyarrow.dataset. - The R pkgdown site references
favicon.svg,favicon-96x96.pngandsite.webmanifest(404 on 147 pages).r/pkgdown/favicon/only has the older favicon set. - Dev pages have about 70 absolute links to stable docs (
/docs/...), and a few have hard-coded/docs/dev/...links. Many could be:ref:/:doc:or relative links. - The
implementations.htmltoctree and table use different URLs for Java, JavaScript, R, Rust and nanoarrow. - These external links need a replacement chosen:
conbench.ursa.dev(DNS does not resolve)- the Intel SDLT page in
format/Columnar.rst(404) - the two JIRA links in
cpp/flight.rst
- A few developer-guide GitHub links are pinned to old commit SHAs, which is intentional for line ranges but may be outdated.
Links that looked broken but are fine: arrow.apache.org/swift/ (bot-blocked redirect), the Bluesky profile (SPA that returns a 404 status), reporter.apache.org (needs login), and the localhost examples.
Component(s)
Documentation
Reactions are currently unavailable
Activity