apache/apisix

docs: make route matching/filtering information more visible

Open

#10,735 建立於 2023年12月29日

在 GitHub 查看
 (4 留言) (0 反應) (0 負責人)Lua (16,597 star) (2,860 fork)batch import
docgood first issue

描述

Current State

Route matching related information is given here: https://apisix.apache.org/docs/apisix/router-radixtree/ but the page that contains this information is not much visible.

Desired State

To fix this I raised this PR: https://github.com/apache/apisix/pull/10413, but it didn't seem like a good solution. Anyone interested can take a look at the conversation to find a better way to address this problem.

貢獻者指南

技術棧
無
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
needs maintainer response
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
needs investigation
前置要求
Understanding of Apache APISIX documentation structureFamiliarity with the router radixtree pageAbility to navigate GitHub discussions
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
50
研究方向
Review the conversation in the linked PR #10413 to understand why the previous solution was not accepted. Identify alternative ways to make the route matching information more visible, such as adding a prominent link on the documentation's sidebar or index page. Consider consulting maintainers for preferred approaches or acceptable modifications to the documentation layout.