Skip to content
This repository has been archived by the owner on Nov 7, 2021. It is now read-only.

Write docs #8

Closed
matt-allan opened this issue May 6, 2019 · 0 comments · Fixed by #21
Closed

Write docs #8

matt-allan opened this issue May 6, 2019 · 0 comments · Fixed by #21

Comments

@matt-allan
Copy link
Owner

Write full documentation for both users and contributors. Instead of stuffing everything into the README we should add a docs directory that stores markdown files. We can build this using Github Pages eventually.

Rough outline:

  • Overview
  • Getting Started
  • Commands
  • Configuration
  • FAQ
  • Contributing
    • How to
    • Pull requests
    • Internals
    • Releases
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Improve docs matt-allan/hours
1 participant
@matt-allan