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

Prevent duplication of documentation in man pages #103

Open
jdorel opened this issue Mar 8, 2021 · 2 comments
Open

Prevent duplication of documentation in man pages #103

jdorel opened this issue Mar 8, 2021 · 2 comments

Comments

@jdorel
Copy link
Contributor

jdorel commented Mar 8, 2021

Hi,
Currently there is some duplication of documentation between the website and the manpages.

Shoud a tool be used to generate both manpages and online documentation, or should manpages and the online documentation contain different content ?

@tbabej
Copy link
Member

tbabej commented Apr 5, 2021

I think this is a direction we'd like to adopt moving forward. The website should contain a superset of information contained in the man pages. In order to get there, we need to do two things:

  • Convert the website to statically generated site (i.e. using jekyll or hugo)
  • Prototype conversion of static docs to manpages (i.e. using pandoc)

@lauft
Copy link
Member

lauft commented Apr 7, 2021

Timewarrior has chosen to use asciidoc as the new documentation format and generates both, the man pages and the HTML pages from it. Asciidoctor delivers the man pages we want and integrates well with Hugo which is used by ti.net.

However, the HTML pages are currently not crosslinked (automatically), see GothenburgBitFactory/ti.net#10. But I think you can define special macros in Asciidoctor which generate the desired result depending on the output format.

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