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

Generate man pages with hidden 'man' command #33

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

muesli
Copy link
Owner

@muesli muesli commented Dec 12, 2021

Todo: We should auto generate them in a GitHub workflow that's triggered by every push to master.

@muesli muesli added the documentation Improvements or additions to documentation label Dec 12, 2021
scene.go Outdated
@@ -6,16 +6,17 @@ import (
"strings"

"github.com/andreykaipov/goobs/api/requests/scenes"
"github.com/andreykaipov/goobs/api/requests/studio_mode"
studiomode "github.com/andreykaipov/goobs/api/requests/studio_mode"
Copy link
Contributor

Choose a reason for hiding this comment

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

This should be in a separate commit.

@bdrung
Copy link
Contributor

bdrung commented Dec 12, 2021

Reviewed the man pages from a users persective:

  • obs-cli.1 should list all subcommand (not just reference them indirectly in "SEE ALSO")
  • obs-cli-completion is not needed since that is not called directly by the user
  • It would be nice if each man page for the subcommand would mention all (e.g. obs-cli-label.1 would document "label countdown" and "label text".) Otherwise you have to jump too much between the man pages.
  • The required parameters are often not correctly documented (e.g. "obs-cli scene switch [flags]" where [flags] is not documented, but this command expects a scene name).
  • The descriptions could be more than just one sentence per command.

Can you add a section to the README that explains how to build the man pages?

It would be nice if obs-cli could ship bash completion config files.

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.

2 participants