Skip to content

[DOC] Add CONFIGURATION.md to document config.json#282

Merged
maurerle merged 3 commits intofreifunk:mainfrom
FFHener:configuration_docs
Jan 8, 2026
Merged

[DOC] Add CONFIGURATION.md to document config.json#282
maurerle merged 3 commits intofreifunk:mainfrom
FFHener:configuration_docs

Conversation

@FFHener
Copy link
Contributor

@FFHener FFHener commented Jan 6, 2026

Description

Start adding documentation for the configuration file. This still needs to be extended.

Motivation and Context

I tried to look at existing deployments and the code to add context to the configuration example.

How Has This Been Tested?

Screenshots/links:

Checklist:

  • My code follows the code style of this project. (CI will test it anyway and also needs approval)
  • My change requires a change to the documentation.
    • I have updated the documentation accordingly.

Add documentation about config.json. This is still unfished, but a starting point.
@FFHener FFHener force-pushed the configuration_docs branch from edb0af1 to 24eb268 Compare January 6, 2026 22:35
@FFHener
Copy link
Contributor Author

FFHener commented Jan 6, 2026

Fixed the linter stuff

Copy link
Member

@maurerle maurerle left a comment

Choose a reason for hiding this comment

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

Thanks! Great, I also intended to work on docs, but I am very happy with this first draft.

@maurerle maurerle merged commit 848e1b9 into freifunk:main Jan 8, 2026
2 checks passed
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.

2 participants