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

Layer documentation #129

Open
gandie opened this issue Jul 15, 2024 · 0 comments
Open

Layer documentation #129

gandie opened this issue Jul 15, 2024 · 0 comments

Comments

@gandie
Copy link
Member

gandie commented Jul 15, 2024

Dropping a few lines here to flush my memory.

Is your feature request related to a problem? Please describe.

People start asking where to read about new layer-update command for example. Pointing to --help only helps a little.

Describe the solution you'd like

Just like the other commands this should be documented here in README, maybe with some examples, best practices and common use cases. Layer diagrams explaining "shadowing / freezing" ( not even sure on term, docs needed! ) objects over layers with example would drive tears into my eyes 😉

Describe alternatives you've considered

Reading help text on cli, experiments with --dry-run and of course reading code itself

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

1 participant