Documentation and user guide

[W0RMT]

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).

That would be great, Angelo! Thanks.

I'm working on making sure we can easily render the markdown file as a pdf. I think I can do this in Atom, which will make it easier to work within GitHub.

[W0RMT]

OK so we're all set to go with this. Using Atom, I can clone into the repo (right now I'm playing in my forked version) and edit the markdown file, update and insert a table of contents, and render a nice looking pdf. And that way it can easily pull from the media in OpenGD77/docs/media so anything that gets uploaded there in terms of screenshots is easy to put into the markdown file. It should then be easy to just make a PR within Atom to update this in your repo, Roger.

Now we just need to go through and figure out what to update

[VK3KYY]

Thanks Bud

I'd need to check the markdown version and try to notice which functions are missing

Definitely the default squelch and the lookup of the contact name when entering a TG number

[W0RMT]

Thanks Bud

I'd need to check the markdown version and try to notice which functions are missing

Definitely the default squelch and the lookup of the contact name when entering a TG number

I'm just going through the whole thing and making edits and updates, and I've incorporated the new buttons diagram. Enough for tonight. I'll share what i get done sometime tomorrow. But the version in your repository is no longer current.

[VK3KYY]

OK

Thanks..

[W0RMT]

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?)

[VK3KYY]

I've merged the PR and also made some minor changes.

What do you use to edit the MD. Is there a WYSIWYG editor ?? Atom ??

[W0RMT]

I've merged the PR and also made some minor changes.

What do you use to edit the MD. Is there a WYSIWYG editor ?? Atom ??

Atom. Works well if you know basic markdown and some html, or if you just have a reference document to follow. I'm no expert. But Atom is nice for cloning into the repository, making commits and PRs.

[VK3KYY]

OK

Its been a while since I looked at Atom, but I'll try to install it later.

[W0RMT]

You'll need to install these packages:

pdf-view
markdown-themeable-pdf
atom-mdtoc

Optionally:
language-markdown
markdown-writer
markdown-to-html