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.

Sign up for GitHub

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

Jump to bottom

Rewrite docs #131

Open
PossibleLlama opened this issue Feb 4, 2023 · 0 comments
Open

Rewrite docs #131

PossibleLlama opened this issue Feb 4, 2023 · 0 comments

Comments

@PossibleLlama
Copy link
Owner

Is your feature request related to a problem? Please describe.
The documentation as written is aimed towards worklog being a CLI. Given that it has branched into other mechanisms of delivery, this feels incorrect.

The initial README should contain what the app is, what it can do and links off to the UI/related projects. It can sign post to other documentation for the CLI, server etc. These others docs then go into details of how the CLI is used, a swagger document etc.

Describe the solution you'd like
As above.

Additional context
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@PossibleLlama