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

Willing to help with documentation/wiki #438

Closed
WasteOfO2 opened this issue Mar 3, 2023 · 8 comments
Closed

Willing to help with documentation/wiki #438

WasteOfO2 opened this issue Mar 3, 2023 · 8 comments

Comments

@WasteOfO2
Copy link

It has been great to use Saber. It went from an app constantly crashing cuz of my S Pen a few months back to almost being feature complete as of today(for me atleast)

I want to give back to this project by helping the way i know it best. I have contributed to some linux and linux-related wikis in the past. This is going to be a new type of project for me but i do feel like a lower barrier for entry any project is always welcomed.

willing to discuss it in this issue here or move it to Discussions!

@ghost
Copy link

ghost commented Mar 8, 2023

I think it is a nice idea. I can help to develop the documentation and translate it to PT-BR.

However, I think maybe it is better to do this just when the app is close to a stable release.

@WasteOfO2
Copy link
Author

The earlier we start, the more ready and polish it will be by the time stable hits.

If i had to make a guess, we might hit stable within 2-3 months. Last few releases will probably take longer, however, Adil can show better light at this

@ceskyDJ
Copy link
Contributor

ceskyDJ commented Mar 11, 2023

Oh, it grows up here :D. I can help, too (at least sometimes), and translate your work into Czech.

@WasteOfO2
Copy link
Author

@adil192 friendly ping, thoughts?

@adil192
Copy link
Member

adil192 commented Mar 11, 2023

I don't really know what goes into writing a wiki so I probably can't be of much help.
But I've gone ahead and enabled a publicly editable wiki

@WasteOfO2
Copy link
Author

The wiki will have stuff like contributing guidelines, common issues, FAQs, roadmap, current features, etc

Would especially help lower barrier of entry for new devs if the code itself could be documented. Example how PDFs are rendered, how settings are applied, common directories which saber uses, etc etc

These are just a few things from the top of my head, i am sure as more ppl chime in, we can get more stuff done.

It is for u and us to decide what goes in, but we do need pointers from u for what u want documented

@WasteOfO2
Copy link
Author

@adil192 , sorry for multiple pings as of late. Waiting for ur input. Would be nice if u can subscribe to this issue.

We can otherwise move this to discussions

@WasteOfO2
Copy link
Author

Closing this in favour of #471

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants