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

revamp docs #111

Closed
3 of 10 tasks
nrdxp opened this issue Feb 4, 2021 · 1 comment
Closed
3 of 10 tasks

revamp docs #111

nrdxp opened this issue Feb 4, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation priority

Comments

@nrdxp
Copy link
Collaborator

nrdxp commented Feb 4, 2021 •
edited
Loading

We need a more thorough mechanism for documentation covering the following bases:

  • all library functions
  • profile blurbs
  • repo layout description
  • flk command
  • user blurbs
  • common examples of various actions
  • various integration docs
    • deploy-rs
    • NUR
    • devshell

Tracking #113

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.
@Pacman99
Copy link
Member

Pacman99 commented Feb 4, 2021

Maybe a README in each folder that documents the purpose of the code in it and how to use it. It would be obvious for new users learning, and easy for contributors to keep updated.

@nrdxp nrdxp mentioned this issue Feb 7, 2021
Merged
@nrdxp nrdxp added the documentation Improvements or additions to documentation label Feb 15, 2021
@nrdxp nrdxp mentioned this issue Feb 15, 2021
Closed
17 tasks
@nrdxp nrdxp added the priority label Feb 15, 2021
@nrdxp nrdxp mentioned this issue Feb 15, 2021
Closed
@nrdxp nrdxp pinned this issue Feb 17, 2021
@nrdxp nrdxp unpinned this issue Mar 5, 2021
@nova-nowiz nova-nowiz mentioned this issue May 16, 2021
Closed
@Pacman99 Pacman99 closed this as completed Apr 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation priority
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Pacman99 @nrdxp