✏️ [ FEAT REQ ] GitHub Wiki or Other Feature Documentation

[Pinaz993]

qkSMS and quik both have very sparse documentation. (At least, I was not able to find any documentation other than the README.MD.) In fact, I have noticed two instances where people have wanted a feature, unaware that the feature is already implemented.

While it may seem that an SMS/MMS client does not need much in the way of documentation, if written and organized carefully, unneeded docs can't hurt.

In addition, while it may be daunting to dive into Java/Kotlin and learn how to handle shudder Gradle, Markdown is actually quite approachable.

I propose that we, the grateful users of quik, take some of the load off of @octoshrimpy and work to create documentation of the features in the app in such a way that it can be later implemented or linked to in the app itself.

This issue may be useful as a gathering point for information on features of qkSMS and quik.

[Pinaz993]

I'll start with the two features I saw that needed documenting:

• scheduled messages (✏️ [ FEAT REQ ] scheduled messages #69)
• Group text vs. multi-text switch when multiple numbers/contacts are in the recipient field (❓ [ QUESTION ] Should this app be reccomended to those that are not technically inclined? #170)

[Pinaz993]

Many who are not in the know may wonder about RCS support. A paragraph or so should be witten about why this will not happen. (If the situation changes, this can be removed from the documentation.)

[julien-garrigue]

Do you mean that Quik will never support RCS?

[Inhishonor]

@julien-garrigue At the moment, it is not likely that RCS will be supported. This issue is being tracked in #124. We wanted a section in the wiki mainly to explain the reasons and redirect to the issue where the discussion is taking place.

[Inhishonor]

Added in the FAQ. Does it look good?

[Pinaz993]

A development roadmap/planned features list could not only cut down on questions, but also serve as a sort of issue index of sorts, with links to each feature request issue.

[octoshrimpy]

This is fantastic, thank you so much! 💜

I'm working on a small roadmap for "next release" over at QUIK - Next Release (view)

and for those coming in, here's a good place to start for getting friendly with markdown:

https://www.markdownguide.org

[Pinaz993]

QUIK - Next Release (view)

This URL returns a 404, though assuming you see something different, it really should be a 403.

[Pinaz993]

As far as categorization goes, it looks like you can either make a bunch of wiki pages and allow GitHub to simply list them, or you can use Markdown to make a more attractive and better organized sidebar. For example:

# Basics
### Installation
- From GitHub
- Using Obtanium

### Usage
- Writing and sending a Text
- Scheduling a text

This will make a sidebar that looks like the following:

Basics

Installation

• From GitHub
• Using Obtanium

Usage

• Writing and sending a Text
• Scheduling a text

Thus, we have three levels of categorization to work with. I think we'll only need two.

[Pinaz993]

As for what to actually put there, I suggest the following:

Basics

Installation

• From GitHub
• Using Obtanium

Usage

Messages

• Sending & Receiving
• Attachments

Advanced

Messages

• Pinning Conversations
• Scheduling Messages
• Archived Messages
• Multiple Recipients

Side Menu

• Blocked Senders
• Message History Backups
• Inviting Friends

Settings

• Appearance
• General

Miscellaneous

FAQ

Troubleshooting

• Common
• Issues
• Go
• Here

Development

• Planned Features
• Contribution

In theory, every wiki page we write should be one click away with this sidebar.

[Pinaz993]

Currently, the wiki is disabled. You can enable it in Settings > Features

[octoshrimpy]

@Pinaz993 project made public-read, and wiki made public-RW

[Pinaz993]

Wiki landing page created, with struckthrough instructions to navigate with the side bar, an under construction message, and a thanks section based on the one in README.md.

[octoshrimpy]

we may want to link to https://dontkillmyapp.com/ since a couple people have ran into that problem before: https://www.reddit.com/r/fossdroid/comments/1cjl17i/comment/ljcbvkl/?utm_source=share&utm_medium=web3x&utm_name=web3xcss&utm_term=1&utm_content=share_button

[Inhishonor]

Added in the FAQ.

[Pinaz993]

Installation documentation for GitHub and Obtanium Added. Please check and make sure it's clear and understandable.

[Pinaz993]

Sorry I couldn't do anything for a couple of days. Initial Setup page written, with screenshot. Please make sure it is clear and understandable.

[Pinaz993]

Basic usage is finally done and linked in the sidebar! As it turns out, writing Markdown with a phone is not nearly as frustrating and annoying as I expected it to be.

[octoshrimpy]

@Pinaz993 your work is very much appreciated!!

[Inhishonor]

Do you mind if I work on the documentation to? I could add the sections about archiving, scheduling and blocking.

[Pinaz993]

I have no problem with it, and I don't think our dear dev will have a problem either, considering how he reacted to my offer.

…

On Thu, Jan 9, 2025 at 10:29 PM Inhishonor ***@***.***> wrote: Do you mind if I work on the documentation to? I could add the sections about archiving, scheduling and blocking. — Reply to this email directly, view it on GitHub <#174 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AA6UQEIC7OSQ6MHUCDHP3EL2J45CLAVCNFSM6AAAAABRNSVJP6VHI2DSMVQWIX3LMV43URDJONRXK43TNFXW4Q3PNVWWK3TUHMYTCNZZGM2DEMI> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[Inhishonor]

Great! I will work on it.

[Inhishonor]

I added:

• Scheduling Messages
• Archiving Messages
• Blocking Numbers
  I also added a link in the Menu to a page for sorting messages based on this pull request. make unread conversations float at the top of conversation lists #213 Please double check that it is clear and there are no typos. Thanks!

[Pinaz993]

Wunderbar! Thank you very much for your contribution, good sir!

[octoshrimpy]

@Inhishonor thank you for all your help! in my book you are a sir/madam and a scholar!

[Inhishonor]

Added Sorting Messages, Backup and Restore and set up the Settings page. At what point do you think that the wiki is complete enough to add links in the F-Droid description, Readme and within the app? Also, do you think we should add a thank you to @gavine99 in the Thank you section, given the amount of amazing features they have added? Thanks!

[Inhishonor]

I added renaming conversations, inviting friends and adding a contributing guidelines. @octoshrimpy Could you take a look at the contributing guidelines especially. I know it is customary to have the project owner create that, so I wanted to make sure you liked it. Also, I still haven't figured out how to get it to build locally, and so if you could possibly write instructions for that, that would be really helpful. Does everything else look good?

[connect-mahdi]

Hi all ! What a GREAT project !

I hope you don't mind if I indicate here, as a QUIK user, that there is a very useful backup app for SMS/MMS and much more:
You might take a look at this project for backup purpose https://github.com/tmo1/sms-ie

[Inhishonor]

Assuming everyone else agrees, I will add it as an option. Thanks!

[connect-mahdi]

Backup and Restore being part of one whole process, it might be helpful to include details about the restoring part and it's several use cases

[Inhishonor]

@octoshrimpy @Pinaz993 I added a bunch of pages to the Wiki. Settings, Voice Actions, FAQ. I also filled out the development section, and added a section in the installation page, about the restricted settings annoyance. Does it look good? What else can be added to the wiki? Thanks!

[Pinaz993]

It looks very good. Thank you for all your work on this. We'd have very little Wiki without your efforts.

…

On Sun, May 11, 2025, 14:13 Inhishonor ***@***.***> wrote: Added in the FAQ <https://github.com/octoshrimpy/quik/wiki/Frequently-Asked-Questions>. Does it look good? — Reply to this email directly, view it on GitHub <#174 (reply in thread)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AA6UQEP6WWMG5Z2EENY53NT256HNPAVCNFSM6AAAAABRNSVJP6VHI2DSMVQWIX3LMV43URDJONRXK43TNFXW4Q3PNVWWK3TUHMYTGMJQHA4TQMQ> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[Inhishonor]

No problem. Also, thank you for spearheading this and setting up a template. It made it really easy to add sections.