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

Improving findability of "help my checkers aren't loading" doc #1611

Closed
terriko opened this issue Mar 23, 2022 · 1 comment · Fixed by #1612
Closed

Improving findability of "help my checkers aren't loading" doc #1611

terriko opened this issue Mar 23, 2022 · 1 comment · Fixed by #1612
Labels
good first issue Good for newcomers

Comments

@terriko
Copy link
Contributor

terriko commented Mar 23, 2022

Regarding this section of the docs:
https://cve-bin-tool.readthedocs.io/en/latest/CONTRIBUTING.html#help-my-checkers-aren-t-loading

If you look at the index for our docs, you'll see that this section doesn't show in the index:
https://cve-bin-tool.readthedocs.io/en/latest/index.html

That's because we only show headers at the level above that one. But the question about checker loading has come up a few times and I think we should probably make it more visible. This can be done by changing the number of "#" characters in CONTRIBUTING.md (and don't forget to update the table of contents in the doc; I use a Visual Studio Code plugin to do that but it can also be done manually), or it could be done by changing the table of contents depth in doc/index.rst

I'm not sure offhand which one will look better, so feel free to try both and choose one for a PR. You can build the docs by going into the doc/ folder and typing make, though you may need to install dependencies first (they're in doc/requirements.txt).

@terriko terriko added the good first issue Good for newcomers label Mar 23, 2022
@terriko
Copy link
Contributor Author

terriko commented Mar 23, 2022

Also: If you've already had a pull request merged, please leave this one for a new contributor! (It's really not urgent and is perfect for someone who wants to learn how to build our docs.)

MohitOhlyan added a commit to MohitOhlyan/cve-bin-tool that referenced this issue Mar 26, 2022
terriko added a commit that referenced this issue Mar 29, 2022
Co-authored-by: Terri Oda <terri@toybox.ca>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant