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

documentation #18

Closed
atticus-sullivan opened this issue Dec 16, 2024 · 2 comments · Fixed by #31, #33 or #35
Closed

documentation #18

atticus-sullivan opened this issue Dec 16, 2024 · 2 comments · Fixed by #31, #33 or #35
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@atticus-sullivan
Copy link
Owner

I don't like the pdf documentation that much anymore. Maybe we can restructure/rewrite/restyle it on the long-term.

Also we should consider shortening the -h output and refer to texdoc cluttealtex for the more verbose documentation (after we've rewritten that .pdf documentation)

@atticus-sullivan atticus-sullivan added the documentation Improvements or additions to documentation label Dec 16, 2024
@atticus-sullivan atticus-sullivan self-assigned this Dec 16, 2024
@atticus-sullivan atticus-sullivan mentioned this issue Dec 16, 2024
@atticus-sullivan atticus-sullivan added this to the v0.9.9 milestone Dec 22, 2024
@atticus-sullivan
Copy link
Owner Author

atticus-sullivan commented Jan 1, 2025

Todo:

  • check --no
  • short options
  • check initial values
  • check refkeys (list both (config/cli) always)
  • check if there are new options (watch should have a new one)

  • start with draft -> boolean
  • skip first -> boolean
  • fresh -> boolean
  • verbose -> accumulating
  • print_output_directory -> boolean

@atticus-sullivan atticus-sullivan linked a pull request Jan 3, 2025 that will close this issue
@atticus-sullivan
Copy link
Owner Author

atticus-sullivan commented Jan 5, 2025

#31 alone does not fix this. There is also need for two more PRs:

  • have a closer look at the options -> make adjustments (probably those noted above)
  • rewrite printing the help output (should be just a short listing of all options and refer to the pdf documentation (ctan/github/texdoc for detailed docs).

@atticus-sullivan atticus-sullivan linked a pull request Jan 6, 2025 that will close this issue
This was referenced Jan 6, 2025
@atticus-sullivan atticus-sullivan linked a pull request Jan 6, 2025 that will close this issue
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
1 participant