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.