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

[Documentation] Improve clarity and organization of documentation #9

Open
chiragbiradar opened this issue Sep 23, 2023 · 2 comments
Open
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest-accepted Issues accepted for hacktoberfest help wanted Extra attention is needed

Comments

@chiragbiradar
Copy link
Owner

Description:

Please describe the specific part of the documentation that you think is unclear or unorganized, and suggest a change that would improve it.

Examples:

For example some References are not linked to their research paper

  • Unorganized: Please rephrase the installation instructions for improved clarity
  • More organized: Add code blocks where required,
    Please note: This issue template is for small changes to the documentation. If you have a suggestion for a larger change, such as adding a new section or reorganizing the entire documentation, please create a separate issue.

Thank you for helping to improve the documentation!

Additional notes:

  • When submitting an issue, please be as specific as possible about the problem and the suggested solution.
  • Please include screenshots or code snippets to help illustrate the problem and the solution.
  • If you are able to make the change yourself, please submit a pull request with your changes.
  • If you are not able to make the change yourself, please be patient and we will try to address the issue as soon as possible.
@chiragbiradar chiragbiradar added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers hacktoberfest-accepted Issues accepted for hacktoberfest labels Sep 23, 2023
@chiragbiradar chiragbiradar changed the title [Documentation] Improve clarity and organization of documentation for [topic] [Documentation] Improve clarity and organization of documentation Sep 23, 2023
dhruvthakur2000 added a commit to dhruvthakur2000/DDoS-Attack-Detection-and-Mitigation that referenced this issue Oct 12, 2023
[Documentation] Improve clarity and organization of documentation chiragbiradar#9
@dhruvthakur2000
Copy link
Contributor

Hi @chiragbiradar I still see some faults in the docs should I work on them ?I would be glad to contribute

@chiragbiradar
Copy link
Owner Author

Hi @dhruvthakur2000 ,
Yes, please work on the faults you see in the docs. We would be glad to have your contributions.
Please let us know if you have any questions or need any help.

dhruvthakur2000 added a commit to dhruvthakur2000/DDoS-Attack-Detection-and-Mitigation that referenced this issue Oct 19, 2023
chiragbiradar added a commit that referenced this issue Oct 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest-accepted Issues accepted for hacktoberfest help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants