renovatebot/renovate

Add link to documentation site from JSON Schema

Open

#41 815 ouverte le 11 mars 2026

Voir sur GitHub
 (1 commentaire) (1 réaction) (0 assignés)TypeScript (14 066 stars) (1 916 forks)batch import
core:docscore:json-schemahelp wantedpriority-3-medium

Description

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)

Guide contributeur

Stack technique
typescriptnodejs
Domaine
documentationtooling
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
fresh
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Basic understanding of JSON SchemaFamiliarity with Renovate config structure
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75
Direction de recherche
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.