renovatebot/renovate

Add link to documentation site from JSON Schema

Closed

#41,815 opened on Mar 11, 2026

View on GitHubContributor guide
 (1 comment) (1 reaction) (0 assignees)TypeScript (1,916 forks)batch import
core:docscore:json-schemahelp wantedpriority-3-medium

Repository metrics

Stars
 (14,066 stars)
PR merge metrics
 (Avg merge 2d 23h) (339 merged PRs in 30d)

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

Research direction
Scan the JSON schema files for configuration options and add a 'seeAlso' or 'See also' link field pointing to the relevant documentation page. Ensure the link URL matches the option's documentation path.
Tech stack
typescript
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScriptJSON Schema
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75