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

Update docs and readme from generated readme command #76

Closed
kzu opened this issue Jan 31, 2021 · 0 comments
Closed

Update docs and readme from generated readme command #76

kzu opened this issue Jan 31, 2021 · 0 comments
Labels
enhancement New feature or request

Comments

@kzu
Copy link
Member

kzu commented Jan 31, 2021

The main readme is out of date with regards to the commands help (and examples).

We should ensure we always generate the readme from the generate-readme command instead, to avoid this in the future.

Take the chance to update missing templates for newer commands, and add some examples.

Back this issue
Back this issue

@kzu kzu added bug Something isn't working enhancement New feature or request and removed bug Something isn't working labels Jan 31, 2021
kzu added a commit that referenced this issue Feb 1, 2021
Update docs from manually-crafted readme.md, and re-run `generate-readme` command to sync it all.

Fixes #76
@kzu kzu closed this as completed in 4c41ec0 Feb 1, 2021
kzu added a commit that referenced this issue Feb 1, 2021
Update docs from manually-crafted readme.md, and re-run `generate-readme` command to sync it all.

Fixes #76
@devlooped devlooped locked and limited conversation to collaborators Oct 23, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant