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

Doc tweaks #313

Merged
merged 5 commits into from
Dec 9, 2024
Merged

Doc tweaks #313

merged 5 commits into from
Dec 9, 2024

Conversation

mmlb
Copy link
Contributor

@mmlb mmlb commented Dec 5, 2024

Bunch of minor fixes and then adding nix to the list of oses that packages flent.

The fixes are mostly cosmetic tweaks, more info in the commit messages.

@mmlb
Copy link
Contributor Author

mmlb commented Dec 5, 2024

I used https://github.com/kristoff-it/superhtml to find the fixes and would recommend using its fmt sub-command, it cleaned up the html nicely. Let me know if that works for you and I'll add a reformat commit too.

mmlb added 4 commits December 5, 2024 14:00
Found using superhtml:
```
$ superhtml check doc/_templates/index.html
doc/_templates/index.html:5:3: html_elements_cant_self_close
doc/_templates/index.html:37:72: erroneous_end_tag
doc/_templates/index.html:38:76: missing_end_tag
doc/_templates/index.html:38:30: missing_end_tag
```

Signed-off-by: Manuel Mendez <[email protected]>
Other sub-sections have Sentence case, this was the only one with
initial caps.

Signed-off-by: Manuel Mendez <[email protected]>
README was missing Gentoo. Moved Arch linux up so the almost
alphabetically sorted linux distros would in fact be sorted.

I split OSX from "Other Linux" in index.html to match the other files. I
changed the content to point to intro.html#installing-flent as it wasn't
a one/two liner like the others so seemed to be better off as a link.

Signed-off-by: Manuel Mendez <[email protected]>
@tohojo
Copy link
Owner

tohojo commented Dec 6, 2024

No objection to any of these, thanks for the fixes!

And sure, feel free to add a reformat commit as well, and I'll take a look...

Originally tried with prettier but I think superhtml's output is nicer.

Signed-off-by: Manuel Mendez <[email protected]>
@mmlb
Copy link
Contributor Author

mmlb commented Dec 6, 2024

I've added the re-format commit.

Copy link
Owner

@tohojo tohojo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good - thank you for the fixes! :)

@tohojo tohojo merged commit c328607 into tohojo:master Dec 9, 2024
56 of 63 checks passed
@mmlb mmlb deleted the doc-tweaks branch December 9, 2024 18:46
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.

2 participants