Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

draft updated manpage #3378

Closed
wants to merge 1 commit into from
Closed

Conversation

pljones
Copy link
Collaborator

@pljones pljones commented Sep 21, 2024

Short description of changes

Review and update the Jamulus.1 manpage documentation

CHANGELOG: Review and update the Jamulus.1 manpage documentation

Context: Fixes an issue?

See jamulussoftware/jamuluswebsite#1043

Does this change need documentation? What needs to be documented and how?

This is documentation :)

Status of this Pull Request

Under discussion still. Proof of concept. I've not even got as far as reviewing against the command line options.

What is missing until this pull request can be merged?

Discussion first. Decide whether I've gone too far, not far enough, need to revert, etc.

Checklist

  • I've verified that this Pull Request follows the general code principles
  • I tested my code and it does what I want
  • My code follows the style guide
  • I waited some time after this Pull Request was opened and all GitHub checks completed without errors.
  • I've filled all the content above

@gilgongo
Copy link
Member

gilgongo commented Sep 22, 2024

Not very familiar with man page conventions, but why is the "Jamulus knows four modes of operation..." section at the end and not with the "Description" section?

BTW I'm assuming the general style and approach here is going to be different from the website (eg bold use of semicolons, and terms like "Jamulus knows" etc.)

@pljones pljones closed this Oct 1, 2024
@pljones pljones deleted the update-manpage branch October 1, 2024 12:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants