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

Better docs! #215

Open
4 tasks
spenserblack opened this issue Dec 6, 2022 · 0 comments
Open
4 tasks

Better docs! #215

spenserblack opened this issue Dec 6, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@spenserblack
Copy link
Owner

spenserblack commented Dec 6, 2022

#212 Was closed once the docs were fixed (no broken tags, no blatantly false info), but the docs still have room for improvement. If you like writing documentation, please submit a PR, and feel free to ask me about anything that seems confusing!

IMO, the following subjects can be improved:

  • What is repofetch?
  • How do I write a plugin?
    • This is in CONTRIBUTING.md, but maybe it should be documented somewhere else
    • There should be more guidelines, something like below:
      • "Do not abuse environment variables. They're for values that rarely change, like secrets. They are not a substitute for CLI arguments. Also, consider using the config file instead of the dotenv file. (A clear difference between when to use environment variables, CLI args, and config options should be defined)
      • How to create ASCII art?
      • How to define my own color themes?
      • What exceptions should I raise?
@spenserblack spenserblack added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Dec 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant