renovatebot/renovate

Add link to documentation site from JSON Schema

Open

#41.815 geöffnet am 11. März 2026

Auf GitHub ansehen
 (1 Kommentar) (1 Reaktion) (0 zugewiesene Personen)TypeScript (14.066 Stars) (1.916 Forks)batch import
core:docscore:json-schemahelp wantedpriority-3-medium

Beschreibung

For each configuration option, we should add a link to the docs site, where there is usually more documentation for that given config option

i.e.

    "abandonmentThreshold": {
      "description": "Flags packages that have not been updated within this period as abandoned.\nSee also: https://docs.renovatebot.com/configuration-options/#abandonmentthreshold",
      "type": [
        "string",
        "null"
      ],
      "default": null
    },

We'll need to make sure to route Repo or Self-Hosted config option to the correct page.

(There may be other fields we can use to surface this)

Contributor Guide

Tech Stack
typescriptnodejs
Domain
documentationtooling
Issue Type
documentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Basic understanding of JSON SchemaFamiliarity with Renovate config structure
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75
Research-Richtung
The issue is about adding a 'See also' link to the documentation site for each configuration option in the JSON Schema files. Look at the example provided for 'abandonmentThreshold'. The codebase likely has schema definitions in files like `lib/config/options/index.ts` or similar. Ensure that the link routes correctly based on Repo or Self Hosted docs. Check existing comments or related PRs for guidance.