apache/apisix

docs: make route matching/filtering information more visible

Open

#10735 opened on Dec 29, 2023

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Lua (16,597 stars) (2,860 forks)batch import
docgood first issue

Description

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.

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
needs investigation
Prerequisites
Understanding of Apache APISIX documentation structureFamiliarity with the router radixtree pageAbility to navigate GitHub discussions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
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.