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

Fix the Docs #11

Open
AfroThundr3007730 opened this issue Mar 21, 2019 · 0 comments
Open

Fix the Docs #11

AfroThundr3007730 opened this issue Mar 21, 2019 · 0 comments
Assignees
Labels
docs Documentation related tracking For tracking and meta issues

Comments

@AfroThundr3007730
Copy link
Owner

Like Asian parents with your grades, this issue will always be here to let you know that you're never doing enough. You can always have better documentation.

This issue covers, but is not limited to:

  • In-line code comments for all the things (probably the most crucial)
  • The help syntax and config syntax (users need these things)
  • Documentation on the wiki (for those who don't live in a console)
  • Probably a man page too (those still exist, you know)

Related, and in parallel to: #1

@AfroThundr3007730 AfroThundr3007730 added the docs Documentation related label Mar 21, 2019
@AfroThundr3007730 AfroThundr3007730 self-assigned this Mar 21, 2019
@AfroThundr3007730 AfroThundr3007730 pinned this issue Mar 21, 2019
@AfroThundr3007730 AfroThundr3007730 added the tracking For tracking and meta issues label Mar 21, 2019
Repository owner locked and limited conversation to collaborators Mar 21, 2019
@AfroThundr3007730 AfroThundr3007730 moved this to Tracking in v2.0 Roadmap Mar 9, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
docs Documentation related tracking For tracking and meta issues
Projects
Status: Tracking
Development

No branches or pull requests

1 participant