docs(README): Improve Documentation for better readability - #4672
docs(README): Improve Documentation for better readability#4672vinaypotluri wants to merge 2 commits into
Conversation
e966c81 to
2e460d8
Compare
vinaypotluri
changed the title
Signed-off-by: Vinay Potluri <vinaypotluri8@gmail.com>
2e460d8 to
394cdb8
Compare
vinaypotluri
changed the title
wesbillman
left a comment
wesbillman
left a comment
There was a problem hiding this comment.
Reviewing on Wes Pfleger's behalf.
Two changes are needed before this documentation cleanup is ready:
-
NOSTR.md:57adds- REVIEWto the protocol operation name (kind:9005 - REVIEW). That appears to be an internal editing marker, is unique in the Markdown corpus, and makes the reference table imply thatREVIEWis part of the kind designation. Please remove it. -
docs/multi-tenant-relay.md:446-447remains grammatically and semantically incomplete after replacingthewiththey: “together they fence the h-tag and claimed-community adversary cannot circumvent.” The second clause has no object, and it is unclear what is being fenced. Please rewrite the full clause rather than applying the one-word correction—for example, if this matches the intended model: “together they form the fence that the h-tag and claimed-community adversary cannot circumvent.”
The other three edits are clear grammatical/readability improvements. No test changes are involved.
Remove an accidental editing marker and clarify the multi-tenant application-fence description. Co-authored-by: Carl <c7ebe626f000404285d3686e1dc74cc07cc60a9754a150041ba132e14bd3e2ec@buzz.block.builderlab.xyz> Signed-off-by: Wes <wesbillman@users.noreply.github.com>
Both requested documentation fixes were addressed in a2424f9; dismissing the stale changes-requested review. This is not an approval.
4 participants
Summary
Improve Documentation for better readability
Related issue
NA
Testing
Verified the Markdown renders correctly. Testing not required.