documentation: split up yambar-modules #15

Closed
opened 1 year ago by dnkl · 2 comments
dnkl commented 1 year ago
Owner

The yambar-modules(5) man page is getting quite big. Split it up into one man page per module.

Keep yambar-modules(5), but only list references to the individual man pages.

The **yambar-modules**(5) man page is getting quite big. Split it up into one man page per module. Keep yambar-modules(5), but only list references to the individual man pages.
dnkl added the
doc
label 1 year ago

I can make this if you want.
Some questions though, what do you want for the filename? yambar-modules-modulename.5.scd like yambar-modules-alsa.5.scd?

I let the generic config in yambar-modules.5 and then almost just copy past

yambar-modules-alsa(5)

# NAME
alsa - Monitors an alsa soundcard for volume and mute/unmute changes.

## TAGS

...

## CONFIGURATION

...

## EXAMPLES

...

I can make this if you want. Some questions though, what do you want for the filename? __yambar-modules-modulename.5.scd__ like __yambar-modules-alsa.5.scd__? I let the generic config in yambar-modules.5 and then almost just copy past ``` yambar-modules-alsa(5) # NAME alsa - Monitors an alsa soundcard for volume and mute/unmute changes. ## TAGS ... ## CONFIGURATION ... ## EXAMPLES ... ```
Poster
Owner

I can make this if you want.

It would be greatly appreciated!

Some questions though, what do you want for the filename? yambar-modules-modulename.5.scd like yambar-modules-alsa.5.scd?

Yeah, that sounds good. I was initially going to use yambar-module-name.5.scd (i.e singular, "module"), but I think using plural, "modules", is better. At least for tab completion :)

I let the generic config in yambar-modules.5 and then almost just copy past

That's perfectly fine, though I think we should only use one level of (header) indentation (i.e. # TAGS, not ## TAGS).

> I can make this if you want. It would be greatly appreciated! > Some questions though, what do you want for the filename? yambar-modules-modulename.5.scd like yambar-modules-alsa.5.scd? Yeah, that sounds good. I was initially going to use `yambar-module-name.5.scd` (i.e singular, "module"), but I think using plural, "modules", is better. At least for tab completion :) > I let the generic config in yambar-modules.5 and then almost just copy past That's perfectly fine, though I think we should only use **one** level of (header) indentation (i.e. `# TAGS`, not `## TAGS`).
dnkl referenced this issue from a commit 9 months ago
dnkl closed this issue 9 months ago
dnkl referenced this issue from a commit 9 months ago
Sign in to join this conversation.
No Milestone
No Assignees
2 Participants
Notifications
Due Date

No due date set.

Dependencies

This issue currently doesn't have any dependencies.

Loading…
There is no content yet.