renovatebot/renovate

Add link to documentation site from JSON Schema

Open

#41,815 建立於 2026年3月11日

在 GitHub 查看
 (1 留言) (1 反應) (0 負責人)TypeScript (14,066 star) (1,916 fork)batch import
core:docscore:json-schemahelp wantedpriority-3-medium

描述

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)

貢獻者指南

技術棧
typescriptnodejs
領域
documentationtooling
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Basic understanding of JSON SchemaFamiliarity with Renovate config structure
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
75
研究方向
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.