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

Move to scdoc #1225

Closed
apprehensions opened this issue Nov 2, 2023 · 9 comments
Closed

Move to scdoc #1225

apprehensions opened this issue Nov 2, 2023 · 9 comments

Comments

@apprehensions
Copy link
Contributor

Currently, dunst uses doxygen/pod2man, which is pretty bloated.

scdoc is a very simple man page generator with a much readable markdown format than pod.

I am willing to rewrite the docs in markdown, which itself isnt that hard anyway.

@apprehensions
Copy link
Contributor Author

https://git.sr.ht/~sircmpwn/scdoc

many simple projects such as dunst use scdoc or manually written man pages.

@fwsmit
Copy link
Member

fwsmit commented Nov 2, 2023

I don't think the pod format is too hard to read, but I'm not against replacing it either.

@apprehensions
Copy link
Contributor Author

scdoc is easier to package as it is a small C program. Pod on the other hand requires a whole new language, and its own formatting language instead of Markdown.

@apprehensions
Copy link
Contributor Author

Alongside this change, the docs for the dunst website may have to be redone.

Please consider having a simple suckless website such as https://soju.im/ https://soju.im/doc/soju.1.html

@fwsmit
Copy link
Member

fwsmit commented Nov 7, 2023

The dunst website uses hugo, which also uses markdown. So copying the documentation there shouldn't be too hard right?

@bebehei
Copy link
Member

bebehei commented Nov 7, 2023

A few years ago, I would have supported this to 150%. But especially in the last year, I have learned that docs mostly aren't as simple as markdown is. I acknowledge, that the pod package is bloated, but on the other side, the pod format matured over years and is a perfect fit for man pages.

Just keep this in mind. I don't want to prevent you from any good actions.

@apprehensions
Copy link
Contributor Author

Technically speaking, scdoc is a very very similar format to markdown and could easily be converted back to markdown.

I believe for the time being it should be POD to retain Hugo compatibility up until the build system changes.

@fwsmit
Copy link
Member

fwsmit commented Nov 9, 2023

I'll close this issue, as we are currently not planning to switch.

@fwsmit fwsmit closed this as completed Nov 9, 2023
@apprehensions
Copy link
Contributor Author

Just as a reminder, sway uses scdoc, so i think dunst should too! (also reduces some meson complexity.), i can work on it after the meson PR has been merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants