Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Create a manual for config options #11855

Closed
H-Shay opened this issue Jan 28, 2022 · 2 comments
Closed

Create a manual for config options #11855

H-Shay opened this issue Jan 28, 2022 · 2 comments
Labels
A-Docs things relating to the documentation

Comments

@H-Shay
Copy link
Contributor

H-Shay commented Jan 28, 2022

Currently we keep most of the documentation about config options as comments in the config. This may result in comments becoming out-of-date, useful configuration options being obscured, and is generally a less pleasant reading experience than a manual. It would be nice to move the documentation out of the config file and into a manual.
@H-Shay H-Shay added the A-Docs things relating to the documentation label Jan 28, 2022
@richvdh
Copy link
Member

richvdh commented Jan 31, 2022

I think this might be much the same thing as #8159 ?

@H-Shay
Copy link
Contributor Author

H-Shay commented Jan 31, 2022

You are correct, I will close this in favor of #8159.

@H-Shay H-Shay closed this as completed Jan 31, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
A-Docs things relating to the documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@richvdh @H-Shay