kafbat/kafka-ui

Docs: Improve filters documentation

オープン

#241 opened on 2024/03/22

 (5 件のコメント) (8 件のリアクション) (1 人の担当者)TypeScript (363 件のフォーク)auto 404
good first issuehacktoberfestimpact/documentationstatus/triage/completedtype/chore

Repository metrics

Stars
 (2,554 個のスター)
PR merge metrics
 (PR metrics pending)

説明

Issue submitter TODO list

  • I've searched for an already existing issues here
  • I'm running a supported version of the application which is listed here and the feature is not present there

Is your proposal related to a problem?

No

Describe the feature you're interested in

Currently, the documentation for the filters is a bit barebones and simplistic. Users like me that are new to the syntax are not able to take full advantage of this feature.

image

I would appreciate it the built in documentation of the UI is extended with some sample documents as well as more examples.

Describe alternatives you've considered

Reading the documentation manually is always an option but the UI should try to be self-documented if possible

Version you're running

2956664

Additional context

No response

コントリビューターガイド