Skip to content

Conversation

@ghost
Copy link

@ghost ghost commented Jan 16, 2026

Your checklist for this pull request

  • I've read the guidelines for contributing to this repository.
  • I made sure to follow the project's coding style.
  • I've documented every RZ_API function and struct this PR changes.
  • I've added tests that prove my changes are effective (required for changes to RZ_API).
  • I've updated the Rizin book with the relevant information (if needed).
  • I've used AI tools to generate fully or partially these code changes and I'm sure the changes are not copyrighted by somebody else.

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

...

@wargio
Copy link
Member

wargio commented Jan 16, 2026

while i appreciate the effort, there is a lot of false info in it that is AI slop. just look at RzArch. it does not exists as we havent implemented it yet.

@Rot127
Copy link
Member

Rot127 commented Jan 16, 2026

Second what @wargio said.
For a more detailed discussion see: #5633 (comment) onwards

@Rot127 Rot127 marked this pull request as draft January 16, 2026 12:50
@Rot127
Copy link
Member

Rot127 commented Jan 16, 2026

@prashanthsakapuram I'd close this for now, mostly because those are too many halluzinated changes even on a very brief look. If you'd like to improve the documentation, please do so by experimenting with a module, figure out how it works and then document it.

@Rot127 Rot127 closed this Jan 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Complete each library README.md

3 participants