Skip to content

Configuration documentation: Add a first example and name sections#267

Merged
IshaanDesai merged 1 commit into
developfrom
MakisH-patch-3
May 19, 2026
Merged

Configuration documentation: Add a first example and name sections#267
IshaanDesai merged 1 commit into
developfrom
MakisH-patch-3

Conversation

@MakisH
Copy link
Copy Markdown
Member

@MakisH MakisH commented May 18, 2026

The configuration documentation explains the different settings, without first giving an overview. This PR adds such an overview and the exact names of the sections in the config.

Checklist:

  • I made sure that the CI passed before I ask for a review.
  • I added a summary of the changes (compared to the last release) in the CHANGELOG.md.
  • If necessary, I made changes to the documentation and/or added new content.
  • I will remember to squash-and-merge, providing a useful summary of the changes of this PR.

The configuration documentation explains the different settings, without first giving an overview. This PR adds such an overview and the exact names of the sections in the config.
@MakisH MakisH requested a review from IshaanDesai May 18, 2026 16:15
Copy link
Copy Markdown
Member

@IshaanDesai IshaanDesai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense 👍 There was once such an example configuration, but then I removed it to make the page more concise. But having it is good.

@IshaanDesai IshaanDesai merged commit 4cc4901 into develop May 19, 2026
10 checks passed
@MakisH MakisH deleted the MakisH-patch-3 branch May 19, 2026 16:04
@fsimonis
Copy link
Copy Markdown
Member

This is partially overlapping with #253

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants