JabRef / JabRef/user-documentation

Fix dead links in the docs

Open
#533 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
54
Forks
142
Avg merge
23h 56m
Merged PRs (30d)
12

Description

Some links are dead - see output of action: https://github.com/JabRef/user-documentation/actions/workflows/checks.yaml

Go through one by one and think

Summary

Status Count
🔍 Total 936
✅ Successful 873
⏳ Timeouts 2
🔀 Redirected 0
👻 Excluded 28
❓ Unknown 0
🚫 Errors 33

Errors per input

Errors in en/contributing/how-to-improve-the-help-page.md
Errors in en/cite/export-to-microsoft-word.md
Errors in en/advanced/license.md
Errors in en/collaborative-work/sqldatabase/README.md
Errors in en/advanced/how-to-expand-firstnames.md
  • [ERROR] file:///home/runner/work/user-documentation/user-documentation/.gitbook/assets/expand-firstnames-step-2.png | Failed: Cannot find file
  • [ERROR] file:///home/runner/work/user-documentation/user-documentation/.gitbook/assets/expand-firstnames-step-4.png | Failed: Cannot find file
  • [ERROR] file:///home/runner/work/user-documentation/user-documentation/.gitbook/assets/expand-firstnames-step-1.png | Failed: Cannot find file
  • [ERROR] file:///home/runner/work/user-documentation/user-documentation/.gitbook/assets/expand-firstnames-step-3.png | Failed: Cannot find file
Errors in en/faq/osx.md
Errors in en/advanced/xmp.md
Errors in en/faq/windows.md
Errors in en/installation.md
Errors in en/advanced/knowledge/medlineris.md
Errors in en/contributing/how-to-translate-the-ui.md
Errors in en/ai/ai-providers-and-api-keys.md
Errors in en/advanced/fields.md
Errors in en/related-work/related-work.md
Errors in en/setup/citationkeypatterns.md
  • [ERROR] file:///home/runner/work/user-documentation/user-documentation/en/.gitbook/assets/optionspreferences%20(10).png | Failed: Cannot find file
Errors in en/faq/README.md
Errors in en/collect/import-using-online-bibliographic-database.md
Errors in en/collect/add-entry-using-an-id.md
Errors in en/finding-sorting-and-cleaning-entries/specialfields.md
  • [ERROR] file:///home/runner/work/user-documentation/user-documentation/en/.gitbook/assets/specialfields-6columns-5.2%20(10).png | Failed: Cannot find file
Errors in en/collect/findunlinkedfiles.md
  • [ERROR] file:///home/runner/work/user-documentation/user-documentation/contributing/how-to-improve-the-help-page.md#editing-help-pages-directly-in-the-browser | Failed: Cannot find file

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.

Research direction

Start with the checks.yaml workflow output and inspect each listed documentation file, including en/advanced/license.md, en/advanced/how-to-expand-firstnames.md, and en/collect/findunlinkedfiles.md. Check the referenced repository history, JabRef code, and JabRef issues where the report suggests it. Done means each error has a valid replacement, is intentionally ignored in .lycheeignore, or is confirmed temporary and left unchanged.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.