Documentation and user guide

VK3KYY
Posts: 7590
Joined: Sat Nov 16, 2019 3:25 am
Location: Melbourne, Australia

Re: Documentation and user guide

Post by VK3KYY » Sun Dec 08, 2019 11:03 pm

OK.

Thanks

User avatar
W0RMT
Posts: 178
Joined: Sat Nov 16, 2019 12:45 pm
Location: Louisville, CO USA

Re: Documentation and user guide

Post by W0RMT » Sun Dec 08, 2019 11:05 pm

I'm happy to do the pdf side of things and formatting if you want. That way you can just add content to the markdown file in any editor and let me know when it's ready to render. That way you won't have to mess with Atom and those packages.

VK3KYY
Posts: 7590
Joined: Sat Nov 16, 2019 3:25 am
Location: Melbourne, Australia

Re: Documentation and user guide

Post by VK3KYY » Sun Dec 08, 2019 11:06 pm

I have a PDF writer installed as a printer on my PC, so Atom can print, then I can use that method to generate the PDF

User avatar
DU2XXR
Posts: 191
Joined: Thu Nov 28, 2019 5:25 am
Location: Philippines
Contact:

Re: Documentation and user guide

Post by DU2XXR » Mon Dec 09, 2019 8:58 am

W0RMT wrote:
Sun Dec 08, 2019 10:06 pm
4I1RAC wrote:
Sun Dec 08, 2019 1:17 am
I'd be glad to collaborate in improving the user documentation -- at least in the content/writing part (it's part of what I do for work).
Angelo-

I updated the current OpenGD77 User Guide.md file quite a bit. I would still like to add the new menu diagrams from EA3BIL and do some other things but I'm out of time today. I did include the latest buttons diagram from F1CXG. Do you want to work on it a bit now or when you get a chance? I rendered the pdf from the markdown file in Atom using a markdown-pdf package. I'd be happy to do that again or walk you through it if you want to use that method. I think we are wanting to make the markdown version the latest and working version, and just make the pdfs from it going forward.

I think this is the current to-do with the User Guide:
1. Incorporate menu diagrams from EA3BIL
2. Update screen captures using the new screen capture function in the CPS (all media are in OpenGD77/docs/media)
3. Update some descriptions (new squelch feature, other things in the ### Options section- maybe Roger, Alex, or other devs need to do this?)
I have time to work on it today. What do I need to do?

VK3KYY
Posts: 7590
Joined: Sat Nov 16, 2019 3:25 am
Location: Melbourne, Australia

Re: Documentation and user guide

Post by VK3KYY » Mon Dec 09, 2019 10:54 am

I think its now out of date with the new items in the Options menu for the Default Squelch on VHF, 220Mhz and UHF.

Also the Tone scan is new.

I think also I didnt spent very long explaining the scan, and its settings.

And anything else you can see that has been omitted.

Please feel to change the phrasing if the style is not good in some places

User avatar
F1CXG
Posts: 167
Joined: Sat Nov 16, 2019 7:24 am
Location: GRENOBLE (France)

Re: Documentation and user guide

Post by F1CXG » Mon Dec 09, 2019 12:07 pm

The picture in the PDF is an old badly modified...
My uptated picture is in page 1 of the topic "keys and buttons" ;)

User avatar
W0RMT
Posts: 178
Joined: Sat Nov 16, 2019 12:45 pm
Location: Louisville, CO USA

Re: Documentation and user guide

Post by W0RMT » Mon Dec 09, 2019 12:20 pm

F1CXG wrote:
Mon Dec 09, 2019 12:07 pm
The picture in the PDF is an old badly modified...
My uptated picture is in page 1 of the topic "keys and buttons" ;)
I can update this after Angelo does his work. Thanks, Thierry!

User avatar
F1CXG
Posts: 167
Joined: Sat Nov 16, 2019 7:24 am
Location: GRENOBLE (France)

Re: Documentation and user guide

Post by F1CXG » Mon Dec 09, 2019 12:52 pm

Thank you so much, Bud ;)

( Last Image update 2:05 pm)

User avatar
DU2XXR
Posts: 191
Joined: Thu Nov 28, 2019 5:25 am
Location: Philippines
Contact:

Re: Documentation and user guide

Post by DU2XXR » Mon Dec 09, 2019 2:05 pm

W0RMT wrote:
Mon Dec 09, 2019 12:20 pm
F1CXG wrote:
Mon Dec 09, 2019 12:07 pm
The picture in the PDF is an old badly modified...
My uptated picture is in page 1 of the topic "keys and buttons" ;)
I can update this after Angelo does his work. Thanks, Thierry!
Thanks.will work on copy edits and clarity. Let me do this tonight.

User avatar
W0RMT
Posts: 178
Joined: Sat Nov 16, 2019 12:45 pm
Location: Louisville, CO USA

Re: Documentation and user guide

Post by W0RMT » Mon Dec 09, 2019 2:08 pm

4I1RAC wrote:
Mon Dec 09, 2019 2:05 pm
W0RMT wrote:
Mon Dec 09, 2019 12:20 pm
F1CXG wrote:
Mon Dec 09, 2019 12:07 pm
The picture in the PDF is an old badly modified...
My uptated picture is in page 1 of the topic "keys and buttons" ;)
I can update this after Angelo does his work. Thanks, Thierry!
Thanks.will work on copy edits and clarity. Let me do this tonight.
Sounds good! Let me know when it's ready, and how you want the work to flow (e.g., you submit PR to Roger then I work off that after he merges, or something else).

Post Reply