search

forrestguice / NaturalHour

A roman timekeeping add-on for Suntimes.
GNU General Public License v3.0
30 stars 2 forks source link

Documentation #11

Open BenSira3321 opened 2 years ago

BenSira3321 commented 2 years ago

I began some brainstorming for writing the Documentation do you want to give me access or shall I branch the repository.

Dambond commented 7 months ago

Very great, is it the place to ask difference between notification and quick notification?

forrestguice commented 7 months ago

@BenSira3321 If anyone is interested in writing docs, I think the easiest approach would be to create a new repo (or fork this one), and then use the included wiki, or a static site generator (e.g. GH Pages). If that content was licensed appropriately, I might include it within the app, or would link to it some other way.

@Dambond A normal 'notification' stays in the tray until its explicitly dismissed, while a 'quick notification' remains visible for ~30s (automatically dismissed).

Dambond commented 3 months ago

how can we help?

nognkantoor commented 3 months ago

Documentation is always a good thing, especially when it brings to fore "hidden" features. by way of example, Sun Time Alarms can be configured to trigger when to do Resh, for practioners of that theological persuasion, or Salah, for adherants of that theological persuasion.

Write/outline the various use cases, then writing the documentation becomes a much easier task.

Describe/create user personas, which cover the target user-base of the Suntime applications.

I am very conflicted about writing instructions that aid observance of specific forms of prayer, due to major theological issues of the specific time the observance should be done.

forrestguice commented 2 months ago

I started on a general purpose user manual a couple months ago. It's now at https://forrestguice.codeberg.page/Suntimes/help/ and https://forrestguice.github.io/Suntimes/help/index.html. The content itself is maintained here.

It hasn't been proofread and maybe incomplete, but I realized I'd basically stopped working on it at some point and was unlikely to resume anytime soon.. good tech writing isn't easy and maybe not fun the way coding is. However, I'd like to document all features. Every feature should have at least one sentence explaining it, or at least declaring that it exists.

I'm also conflicted about mentioning various religious use-cases, although I'm fascinated by how many there, or when I learn of a new one. I've tried to make Suntimes a general purpose tool, but I was originally motivated after hiking down from the summit of a steep mountain in the dark (poor planning).