Skip to content

[DOCS] Sync the README repository map with actual directories like wordlists/ and generated output paths #587

@utksh1

Description

@utksh1

Summary

The README repository map is useful, but it does not fully reflect all contributor-relevant directories currently present in the repo.

Scope

  • Audit the top-level map against the actual tree.
  • Add or clarify entries that matter to contributors.
  • Avoid documenting purely transient or ignored paths as if they were source areas.

Acceptance criteria

  • The repo map matches the meaningful checked-in tree.
  • Contributor-relevant directories are easier to discover.
  • Transient/generated paths are described appropriately.

Metadata

Metadata

Assignees

Labels

area:docsDocumentation or contributor guide workbeginner friendlySmall scoped task suitable for beginner contributorsgood first issueFriendly starter issue for first-time contributorslevel:beginner20 pts difficulty label for small beginner-friendly PRspriority:lowNice-to-have issue with low urgencytype:docsDocumentation work category bonus label

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions