Skip to content

add config parameters to docs or package #1743

Open

Description

@kulliax

Hi,

there is always the case that I search for configuration parameters and that is torture. I usually find them in the release notes or look directly in the package.

I would like to see the parameters listed with the corresponding packages (there is always a link to this doc) or alternatively the options are listed for each package in the corresponding chapter.

Activity

  1. renejeglinsky commented on Mar 31, 2025

    @renejeglinsky
    Contributor

    Hi @kulliax ,
    Thanks for opening this issue. Could you give an example?
    Thanks,
    René

  2. kulliax commented on Apr 2, 2025

    @kulliax
    ContributorAuthor
  3. renejeglinsky commented on Apr 25, 2025

    @renejeglinsky
    Contributor

    Hi @kulliax ,
    I can tell that there's work going on. I can't give a timeline yet.
    A first draft PR can be found here: #1667
    We're happy to get your feedback there as well.

    Cheers René

  4. kulliax commented on Aug 6, 2025

    @kulliax
    ContributorAuthor

    Hi @renejeglinsky it's a step in the right direction, more clarity and explanations in the documentation are always good! But I was referring to what is in the changelogs but not in the actual documentation. If you didn't read any of it in the release notes, you wouldn't know that feature x could be changed with y in the behavior. Therefore, I would find it useful to list all the configuration parameters in the respective chapter or the corresponding repo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions