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

Updates to documentation #846

Draft
wants to merge 14 commits into
base: master
Choose a base branch
from
Draft

Conversation

0xBA5E64
Copy link
Contributor

@0xBA5E64 0xBA5E64 commented May 22, 2024

This is a collection of work-in-progress updates to the Av1an docs, spanning the README & Book.

Corrections / comments are greatly appreciated!

@master-of-zen
Copy link
Owner

@shssoichiro Looks good to me, your opinion?

@shssoichiro
Copy link
Collaborator

I'm good with it also 👍

@master-of-zen
Copy link
Owner

One nit pick, i liked previous big screenshot)

@0xBA5E64
Copy link
Contributor Author

One nit pick, i liked previous big screenshot)

Fair enough @master-of-zen , I also did like seeing it, both for the flex and since it shows off Av1an's quite striking progress-meter. However, felt that the project description should be right at the top so that you immediately get to know what the project is about, but this could of course also be remedied by simply moving the screenshot to below the first paragraph too, i just happened to like the more compact "complex" look.

@0xBA5E64
Copy link
Contributor Author

Other than that, I still want to re-write the CLI Reference in the book to be a bit more, readable, before I ready this up for review.

I've been experimenting with some different ways of doing that, most notably by turning those pages into HTML Tables but, it makes the docs a nightmare to maintain, and I fear it'd desentivize people from keeping it in sync with the in-code helptext.

Perhaps the "CLI-Reference" should literally be auto-generated on the docs compiling to be the output of av1an --help, on a single page, just so that users have something to easily Ctrl+F though if they want, with additional written guides to the different parts of av1an's CLI standalone in the docs...

@Vernoxvernax
Copy link
Contributor

Aomenc:
In the description of --lag-in-frames it says 35 is the highest value and 19 the default, but in the examples it reads up to a limit of 48 (default is 35).
Don't know which one is correct.

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

Successfully merging this pull request may close these issues.

4 participants