renovatebot/renovate

Add link to documentation site from JSON Schema

Open

#41815 opened on Mar 11, 2026

View on GitHub
 (1 comment) (1 reaction) (0 assignees)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)

Contributor guide

Tech stack
typescriptnodejs
Domain
documentationtooling
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic understanding of JSON SchemaFamiliarity with Renovate config structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
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.