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.

Sign up for GitHub

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

Jump to bottom

Documentation reorganization #238

Closed

DeemOnSecurity opened this issue Jan 24, 2023 · 0 comments · Fixed by #254

Contributor

DeemOnSecurity commented Jan 24, 2023

I believe the documentation should be organized to make it easier to navigate.

Currently there are 3 types of docs in the repository:

DShield installation documentation
Router configuration documentation
DShield architecture documentation

The documentation would benefit from the following changes:

Create subdirectories in docs: docs/dshield-installation, docs/router-configuration, docs/dshield-architecture
Move all documentation except for: README, LICENSE, SECURITY, ACKNOWLEDGEMENTS, PRIVACY to /docs/
Remove RouterDocs directory

Pull request to implement this issue is in progress.

DeemOnSecurity mentioned this issue

Document Reorganization #254

Merged

jullrich closed this as completed in #254

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment