Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Your checklist for this pull request
RZ_APIfunction and struct this PR changes.RZ_API).Detailed description
This pull request addresses a long-standing documentation gap in the librz/ subsystem.
Several library directories contained empty or missing README.md files, providing no context about the purpose, scope, or responsibilities of the corresponding libraries. This makes onboarding difficult for new contributors and increases friction for reviewers navigating the codebase.
What this PR does
Adds clear, structured README.md files for the following libraries:
librz/arch
librz/bin
librz/config
librz/cons
librz/core
librz/crypto
librz/debug
librz/demangler
librz/diff
librz/egg
librz/flag
librz/il
librz/lang
librz/magic
librz/main
librz/mark
librz/reg
librz/socket
librz/type
Each README:
Explains what the library is responsible for
Describes key features and subsystems
Mentions important core structures and APIs
Clarifies how the library integrates with other parts of Rizin
Avoids duplicating API reference material already covered elsewhere
librz/arch/README.md is aligned with and effectively merged conceptually with existing documentation from:
doc/asm_strings.md
This avoids duplication while making architecture-specific responsibilities discoverable at the library level.
Why this change matters
Improves codebase navigability
Reduces tribal knowledge dependency
Helps new contributors understand where functionality belongs
Makes reviews faster by providing architectural context directly next to code
Does not change behavior, ABI, or public APIs
About AI usage
Portions of the documentation were generated with AI assistance (ChatGPT), then manually reviewed, edited, and validated to ensure:
Technical accuracy
Consistency with existing Rizin concepts
The final content reflects project-specific structure and terminology, not generic boilerplate.
Test plan
This is a documentation-only change and does not affect runtime behavior, APIs, or build output.
Closing issues
closes #5135
...