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

Move documentation into separate docs/ directory #12

Closed
jhachenbergerSIT opened this issue Sep 2, 2019 · 2 comments
Closed

Move documentation into separate docs/ directory #12

jhachenbergerSIT opened this issue Sep 2, 2019 · 2 comments

Comments

@jhachenbergerSIT
Copy link
Contributor

Similar to #11, I would like to propose to move all documentation to a new subdirectory called docs. If I got it correctly, this directory will only contain flawfinder.1. This directory could also contain a makefile to build the documentation.

I admit, it might be disputed to create one directory containing one file, but I see it as an API for a new developer trying to join this project and reading (/searching) the documentation is probably one of the most important things in the beginning and should be as easy as possible. Additionally, a manpage is perhaps (! - this might be wrong) not the most prominent documentation language for a Python-based project and hence, makes it harder to spot it at first.

If you agree with this suggestion, I will create a pull-request with the related changes.

@david-a-wheeler
Copy link
Owner

I don't think creating a subdirectory for a single file is worthwhile. Adding structure (like subdirectories) is good when structure will actually help.

@david-a-wheeler
Copy link
Owner

Thanks for the comment though!

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

2 participants