✏️ [ 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.)

[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 https://github.com/users/octoshrimpy/projects/4/views/1

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

https://www.markdownguide.org

[Pinaz993]

https://github.com/users/octoshrimpy/projects/4/views/1

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

[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!