Skip to content

User Guide update#149

Merged
wmiler merged 17 commits into
JS8Call-improved:masterfrom
Aqueum:user-guide-update
Jan 21, 2026
Merged

User Guide update#149
wmiler merged 17 commits into
JS8Call-improved:masterfrom
Aqueum:user-guide-update

Conversation

@Aqueum

@Aqueum Aqueum commented Jan 18, 2026

Copy link
Copy Markdown
Contributor

Partial improvements to User Guide.

Changes included:
• Fixed broken links and updated repo links
• Removed inadvertent line breaks (presumably added by PDF to markdown conversion)
• Updated available builds to match current releases
• Started to add TODOs
• Revised date and version number, with WIP warning

@Aqueum

Aqueum commented Jan 18, 2026

Copy link
Copy Markdown
Contributor Author

@wmiler – I’ve fixed links and started tidying the User Guide, and wanted to check whether this is heading in the right direction before proceeding further.

@Aqueum Aqueum force-pushed the user-guide-update branch from 6defe79 to 23773ea Compare January 18, 2026 01:55
Comment thread docs/user_guide/JS8Call_User_Guide.md Outdated
Comment thread docs/user_guide/JS8Call_User_Guide.md Outdated
Comment thread docs/user_guide/JS8Call_User_Guide.md
Comment thread docs/user_guide/JS8Call_User_Guide.md Outdated
@wmiler

wmiler commented Jan 18, 2026

Copy link
Copy Markdown
Collaborator

Right direction I think. See my inline comments for a few things. I did notice a couple hanging punctuation marks in there.

Also, note, @Chris-AC9KH and I think @rruchte are working on the whole message box layout, so that might need its own blurb. See #131 for info.

@Aqueum

Aqueum commented Jan 18, 2026

Copy link
Copy Markdown
Contributor Author

Thanks @wmiler - I have responded to all your points, resolved 1 and fixed two punctuation marks. Must be said this PR is only a start. Do we wait for consensus on the more contentious binary downloads and CB questions before continuing the User Guide review/update?

@wmiler wmiler added this to the 2.6.0 milestone Jan 18, 2026
@wmiler

wmiler commented Jan 18, 2026

Copy link
Copy Markdown
Collaborator

I'm ok with you just continuing to update this in the PR. When the team gets around to commenting on something, they will :)

I've tagged this with the 2.6 milestone, as I'm not sure as of yet, if we will have another 2.5 point release.

Comment thread docs/user_guide/JS8Call_User_Guide.md Outdated
Comment thread docs/user_guide/JS8Call_User_Guide.md Outdated
Comment thread docs/user_guide/JS8Call_User_Guide.md Outdated
Comment thread docs/user_guide/JS8Call_User_Guide.md Outdated
Comment thread docs/user_guide/JS8Call_User_Guide.md
Comment thread docs/user_guide/JS8Call_User_Guide.md Outdated
Comment thread docs/user_guide/JS8Call_User_Guide.md Outdated
@Chris-AC9KH

Copy link
Copy Markdown
Collaborator

@Aqueum we have our own website that is much more inclusive than the js8call-improved.com one is
https://js8call-improved.github.io

For 2.6.0 I'm changing the JS8Call UI to pull the User Guide from our website, with a downloadable PDF version for saving offline. The link that will be used for the browser-displayed User Guide in the software is this one:
https://js8call-improved.github.io/JS8Call-improved/d6/d14/md_docs_2user__guide_2JS8Call__User__Guide.html

@Chris-AC9KH

Copy link
Copy Markdown
Collaborator

I fixed the big PR that finished up overhaul of the codebase so it won't interfere with this one. I have been busy working on that big one, so haven't followed this one real close. But it can be merged as desired with a rebase and merge.

@Aqueum

Aqueum commented Jan 19, 2026

Copy link
Copy Markdown
Contributor Author

@Aqueum we have our own website that is much more inclusive than the js8call-improved.com one is https://js8call-improved.github.io

Yes, that is much better. The -improved is rather confusing for newcomers though, so I registered js8call.org and have set it up with A records to GitHub pages' 185.199.108.153, 185.199.109.153, 185.199.110.153 & 185.199.111.153 and a CNAME to js8call-improved.github.io. If an Admin goes to Settings → Pages → Custom domain: js8call.org it should work.

Let me know if you want MX / SPF / DKIM or anything else set up.

It would be great if js8call-improved.com (and possibly even js8call.com) could then also redirect to a single site to avoid confusion.

@Aqueum

Aqueum commented Jan 19, 2026

Copy link
Copy Markdown
Contributor Author

OK, I think I have now addressed all addressable elements and implemented all of @aknrdureegaesr and @wmiler 's suggestions. If @aknrdureegaesr is available to review JS8Call_User_Guide.md following this being rebased and merged into master, I'll jump in as soon as his PR is merged and finish my User Guide review hopefully with plenty time to PDF prior to 2.6 (does it have an ETA?)

I believe that's the most efficient route, as I assume @aknrdureegaesr can review from memory of recent changes, then I'll do a deep dive to check everything works as explained.

Comment thread docs/user_guide/JS8Call_User_Guide.md Outdated
Comment thread docs/user_guide/JS8Call_User_Guide.md Outdated
Comment thread docs/user_guide/JS8Call_User_Guide.md Outdated
Comment thread docs/user_guide/JS8Call_User_Guide.md
Comment thread docs/user_guide/JS8Call_User_Guide.md Outdated
@wmiler

wmiler commented Jan 19, 2026

Copy link
Copy Markdown
Collaborator

Ok, just a few markdown table cleanups, and the question to the team on bumping the Guide version to 2.5.

Since @aknrdureegaesr Andreas wants to PR new content, I think we can merge this whenever so he has a clean base to work from.

@wmiler wmiler added the documentation Improvements or additions to documentation label Jan 19, 2026
Comment thread docs/user_guide/JS8Call_User_Guide.md
@Chris-AC9KH

Copy link
Copy Markdown
Collaborator

@Aqueum we have our own website that is much more inclusive than the js8call-improved.com one is https://js8call-improved.github.io

Yes, that is much better. The -improved is rather confusing for newcomers though, so I registered js8call.org and have set it up with A records to GitHub pages' 185.199.108.153, 185.199.109.153, 185.199.110.153 & 185.199.111.153 and a CNAME to js8call-improved.github.io. If an Admin goes to Settings → Pages → Custom domain: js8call.org it should work.

Let me know if you want MX / SPF / DKIM or anything else set up.

It would be great if js8call-improved.com (and possibly even js8call.com) could then also redirect to a single site to avoid confusion.

I've been so busy with code work I haven't had time to look at this. @wmiler @jsherer if either of you guys have time to set this in the GitHub Pages settings, it is fairly trivial. Otherwise I will do it when I get time.

@Aqueum Aqueum force-pushed the user-guide-update branch from a2f4b56 to b62a968 Compare January 19, 2026 19:20
@jsherer

jsherer commented Jan 19, 2026 via email

Copy link
Copy Markdown
Collaborator

@Aqueum

Aqueum commented Jan 19, 2026

Copy link
Copy Markdown
Contributor Author

All, I’m afraid that adding yet another domain name (.org) will contribute to confuse. Why are we not planning on using js8call.com ?

Perfect, if you are happy to have https://js8call-improved.github.io/ as js8call.com, I can then have js8call.org permanently redirect to js8call.com

@Chris-AC9KH

Copy link
Copy Markdown
Collaborator

@jsherer js8call.com DNS records does not point to the Pages website and it is way out of date. js8call.com is currently hosted on Google Cloud on a single IP 34.144.223.105. The DNS records do not point to https://js8call-improved.github.io where all the official documentation is. It is not clear who owns the js8call.com domain, nor who can change the DNS records for it, since it is registered under Domains By Proxy.

The js8call.com domain does no good when it contains outdated information.

@Chris-AC9KH

Copy link
Copy Markdown
Collaborator

@aknrdureegaesr the versioned User Guide is hosted with the release assets. So it is best to include the version number of the Guide that matches that release. We do need a version 2.5.0 of the Guide so I can convert it to PDF and upload it to the 2.5.x release assets. When this is done I suggest squashing all the commits into one for a cleaner commit history before merging.

@wmiler wmiler left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few things left to do, but we will grab them later.

@wmiler wmiler merged commit c0198aa into JS8Call-improved:master Jan 21, 2026
@wmiler wmiler changed the title WIP User Guide update User Guide update Jan 21, 2026
@Chris-AC9KH

Copy link
Copy Markdown
Collaborator

Updated PDF uploaded to the 2.5.1 release assets.

@Aqueum Aqueum mentioned this pull request Apr 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants