apps4av / avare

Avare Aviation GPS for Android
Other
148 stars 120 forks source link

Improvements to Help Page #488

Open shosk opened 1 year ago

shosk commented 1 year ago

Last fall, I worked with Peter G. to make several improvements and corrections to the out-dated Avare Help page. Unfortunately, there was no follow up, so I am posting my draft here. I struck through words to be removed. The yellow text is my proposed change. The orange text is my comments or suggestions.

I would be happy to work with anyone on this task.

Help-1.docx

apps4av commented 1 year ago

Thanks for the help. We need someone to proof read for correctness. @John W SBA @.***> can you help? Thanks

On Tue, Jan 17, 2023, 3:20 PM shosk @.***> wrote:

Last fall, I worked with Peter G. to make several improvements and corrections to the out-dated Avare Help page. Unfortunately, there was no follow up, so I am posting my draft here. I struck through words to be removed. The yellow text is my proposed change. The orange text is my comments or suggestions.

I would be happy to work with anyone on this task.

Help-1.docx https://github.com/apps4av/avare/files/10439093/Help-1.docx

— Reply to this email directly, view it on GitHub https://github.com/apps4av/avare/issues/488, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAWPRT6HALLKFYNBFQU6SOLWS35ITANCNFSM6AAAAAAT6JCED4 . You are receiving this because you are subscribed to this thread.Message ID: @.***>

JohnW4SBA commented 1 year ago

shosk wrote:

I would be happy to work with anyone on this task.

Wow, great work! Thank you for taking this on. I've set aside some time to take a look just now. Here are a few notes (green BG, comments in italics) so far (down to "Main Avare Screens"). Please let me know if any of this is helpful and you'd like me to do more when time permits. It's fine as-is, imo - and a welcome overdue update on what we had before.

shosk commented 1 year ago

I don't see your attachment. I barely know anything about github.

On Wed, Jan 18, 2023 at 10:44 PM JohnW4SBA @.***> wrote:

shosk wrote:

I would be happy to work with anyone on this task.

Wow, great work! Thank you for taking this on. I've set aside some time to take a look just now. Here are a few notes (green BG, comments in italics) so far (down to "Main Avare Screens"). Please let me know if any of this is helpful and you'd like me to do more when time permits. It's fine as-is, imo - and a welcome overdue update on what we had before.

— Reply to this email directly, view it on GitHub https://github.com/apps4av/avare/issues/488#issuecomment-1396433664, or unsubscribe https://github.com/notifications/unsubscribe-auth/AQQ5M5UBDFKV2BNJ5LW25L3WTDBBLANCNFSM6AAAAAAT6JCED4 . You are receiving this because you authored the thread.Message ID: @.***>

shosk commented 1 year ago

It would probably be useful to incorporate most, if not all, of the New Features into the main section. This might be another separate project. Peter G. thought it would be good to have a tabbed Help section. While this would sure help navigating through it all, it is way above my pay grade. So, for mow, let's just get the single page looking right.

JohnW4SBA commented 1 year ago

Shosk wrote:

I don't see an attachment.

Ah. Hadn't noticed that my reply was to github. Please email me directly or in a Forum post and I'll send it again as an email attachment.

I barely know anything about github.

Probably much more than I. Still, it seems to me best if we collaborate directly and then figure out how to update the final onto github. I've edited there before, but it's long enough ago I'd be starting from scratch.

gustafson commented 1 year ago

Hey guys, sorry I've not responded if I indicated I was going to help on this one.  I lack memory of any details of this.

Shosk, for clarity, the in-app documentation is not something I've messed with (well... not in a long time at least).  I restarted the online documentation renewal, but for the moment these are separate with a vision of future unification.

If you don't know github or git, best is to edit the in-app html file directly (Download the source file, keeping it as html. Use a true text editor like notepad if you can, as word makes too many changes behind the scenes. Don't save as a word document (.docx), rather save as html (.html). Then send it to someone who can interact with git.

Thanks for sticking with it... updating documentation is one of the hardest parts of the project!

Pete

On 1/20/23 19:00, JohnW4SBA wrote:

Attention: This email is from outside Western Michigan University. Use caution when opening links and attachments.

Shosk wrote:

I don't see an attachment.

Ah. Hadn't noticed that my reply was to github. Please email me directly or in a Forum post and I'll send it again as an email attachment.

I barely know anything about github.

Probably much more than I. Still, it seems to me best if we collaborate directly and then figure out how to update the final onto github. I've edited there before, but it's long enough ago I'd be starting from scratch.

— Reply to this email directly, view it on GitHub https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fapps4av%2Favare%2Fissues%2F488%23issuecomment-1399086709&data=05%7C01%7Cpeter.gustafson%40wmich.edu%7C16bee4e0a4df42ff5f3408dafb428d5a%7C257622517aa94c72905f39bf026a8a84%7C0%7C0%7C638098560508583848%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=X200cjmP0AKHCcV9oOR%2B%2FzmmudFszxkb5Y8L0JXtv1w%3D&reserved=0, or unsubscribe https://nam11.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAAIN4GJFRYY7WIYESX3SBG3WTMRK7ANCNFSM6AAAAAAT6JCED4&data=05%7C01%7Cpeter.gustafson%40wmich.edu%7C16bee4e0a4df42ff5f3408dafb428d5a%7C257622517aa94c72905f39bf026a8a84%7C0%7C0%7C638098560508583848%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C3000%7C%7C%7C&sdata=F0fN0B4GZOqZeT2vKJph4x45NROBN0bI0PIfLtSq%2FZc%3D&reserved=0. You are receiving this because you are subscribed to this thread.Message ID: @.***>

-- Peter A. Gustafson, PhD Professor of Mechanical and Aerospace Engineering Western Michigan University G-215 Floyd Hall Kalamazoo MI 49008-5343 Phone: 269-276-3423

shosk commented 1 year ago

John, I don't know your email address. Please send it to me. I'm at Sam.Hoskins gmail.

Here is a suggestion. Why don't you proof read for content accuracy the original .docx document, posted at the start of this thread? At the same time, I will start working on the HTML source and be making the changes there. Then we can hand it over to Zubin or Peter when we think it's ready.

JohnW4SBA commented 1 year ago

John, I don't know your email address. Please send it to me.

Thanks, Sam. I've emailed you the docx just now, and look forward to working with you via email. Your work on this is a significant contribution to Avare users.