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

Help wanted to improve documentation. #558

Open
Tracked by #596
AethanFoot opened this issue Oct 31, 2021 · 0 comments
Open
Tracked by #596

Help wanted to improve documentation. #558

AethanFoot opened this issue Oct 31, 2021 · 0 comments
Labels
help wanted Extra attention is needed

Comments

@AethanFoot
Copy link
Member

The is a call-to-arms of anyone who wants to help out. The task at hand is improving the code documentation and the information in the wiki.

For the code documentation follow the guides provided by rust. The xwrap folder (leftwm-core/src/display_servers/xlib_display_server/xwrap) have been documented, with helper comments for new contributors. The helper comments should only need to detail anything not clear from the code, or if you have a link to something explaining stuff in the code is great.

The wiki is open to be added to. We appreciate it if you add something not already mentioned, want to improve the already documented stuff, or just want to add some tips & tricks/trouble shooting points.

When I have some more time I will add a list of code areas that need documenting, unless someone else wants to attach one first.

Many Thanks!

@AethanFoot AethanFoot pinned this issue Oct 31, 2021
@VuiMuich VuiMuich mentioned this issue Nov 7, 2021
@hertg hertg added the help wanted Extra attention is needed label Nov 7, 2021
@VentGrey VentGrey mentioned this issue Nov 10, 2021
@AethanFoot AethanFoot mentioned this issue Dec 2, 2021
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants