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

Add user docs #23

Open
malankriel opened this issue Mar 2, 2022 · 1 comment
Open

Add user docs #23

malankriel opened this issue Mar 2, 2022 · 1 comment
Assignees

Comments

@malankriel
Copy link

mkdocs setup for instructions on how to set up, etc etc

@rudolfbyker
Copy link

rudolfbyker commented Feb 20, 2023

@heetbeet as discussed today, it's best to have everything specified in a single configuration file, like application.yaml (YAML is a great file format for human-written config, so I would not change that), and then just document the config file properly. The config file is then front-and-centre both in the documentation and in the user experience. This is how most build tools work, and how most tools in the JS/Node world work, how mypy works, how mkdocs itself works. Having it scan for scripts having specific names is not that great. Rather, let the user specify the pre and post scripts in application.yaml.

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

No branches or pull requests

4 participants