Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Overhaul documentation #264

Open
tiedotguy opened this issue Sep 21, 2019 · 1 comment
Open

Overhaul documentation #264

tiedotguy opened this issue Sep 21, 2019 · 1 comment
Assignees

Comments

@tiedotguy
Copy link
Collaborator

Some of the configuration settings, particularly older ones, are either undocumented entirely, or live only in the change-log.

This should be cleaned up, and every single setting and default documented. [README.md] should contain project information, and refer to other files for documentation, ideally not in the root directory which is already a mess (and something I also want to clean up)

@tiedotguy
Copy link
Collaborator Author

These comments have some notes on architecture / performance / scaling:

I wanted to wait until clustering was in before doco overhaul, but it's likely to be a while, and I have some spare time now (but not enough to get clustering), so I may start on this with a focus on the perf/arch documentation in the coming days.

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

No branches or pull requests

1 participant