docs: fix broken links in README and model references - #1599
Merged
Conversation
Signed-off-by: Zhu yizhang <95731595+godarrenw@users.noreply.github.com>
marcopeix
approved these changes
Aug 31, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Fixes four broken links: the docs badge and the emoji-key link in the README, and the AAAI reference in the
DLinear/NLineardocstrings.1. Docs badge points at the retired site (
README.md:16)nixtla.github.io/neuralforecastis no longer served and returns 404. This affects the badge twice: the link goes nowhere, and because shields.io probes that same URL for its up/down state, the badge currently renders red. The badge SVG served today reportsaria-label="docs: down"; with the URL updated it reportsaria-label="docs: up".README.md:58already links tonixtlaverse.nixtla.io, so this looks like the one spot the docs migration missed — it is the only remainingnixtla.github.ioreference in the repository. The probe protocol is also bumped fromhttptohttpsto match.2. AAAI reference points at the wrong article (
dlinear.py:88,nlinear.py:52)Both docstrings cite Zeng et al., Are Transformers Effective for Time Series Forecasting? but link
AAAI/article/view/27695, which 404s.The correct article ID is
26317. Verified via Crossref — DOI10.1609/aaai.v37i9.26317resolves to:Are Transformers Effective for Time Series Forecasting?The volume and issue (
v37i9) match theVol. 37. No. 9. 2023already written in the citation text, andhttps://ojs.aaai.org/index.php/AAAI/article/view/26317returns 200.3. all-contributors emoji key (
README.md:135)allcontributors.org/docs/en/emoji-key404s. This uses the current canonical URLhttps://allcontributors.org/en/reference/emoji-key/(200) rather than a URL that merely redirects. The line sits outside theALL-CONTRIBUTORS-LISTmarkers, so the bot will not overwrite it.How I checked
Extracted every http(s) URL from the repository's Markdown and Python files and resolved each with
curl -L, keeping only genuine 404s — redirects that still resolve were left alone. The AAAI article ID was confirmed against Crossref rather than by guessing an offset. Both badge states were read from the live shields.io SVG.Documentation only — the two Python changes are inside docstrings,
python -m py_compilepasses on both, and no functional code is touched.Disclosure: prepared with AI assistance; every link and the article identity were verified manually.