docs(examples): add READMEs for p/nt packages#5950
Open
davd-gzl wants to merge 2 commits into
Open
Conversation
Rewrite the generated README drafts across the p/nt package family into hand-written docs with a consistent shape (titled one-line summary, usage example, API reference, notes), and add READMEs for markdown/foreign, markdown/sanitize, and ownable/exts/authorizable. Examples and signatures follow current master: rlm-threaded methods, the single-return avl/bptree Get, and the single ownable NewWithAddress constructor. Render-safety notes point realms at p/nt/markdown/sanitize for untrusted input. Also updates the quarantined pausable and watchdog.
Collaborator
🛠 PR Checks SummaryAll Automated Checks passed. ✅ Manual Checks (for Reviewers):
Read More🤖 This bot helps streamline PR reviews by verifying automated checks and providing guidance for contributors and reviewers. ✅ Automated Checks (for Contributors):🟢 Maintainers must be able to edit this pull request (more info) ☑️ Contributor Actions:
☑️ Reviewer Actions:
📚 Resources:Debug
|
notJoon
approved these changes
Jul 15, 2026
notJoon
left a comment
Member
There was a problem hiding this comment.
Left a few nits, but looks good to me 👍
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Adds documentation for the
p/ntpackages, following a consistent format: summary, usage example, API reference, and notes. Three packages that had none get new READMEs:markdown/foreign,markdown/sanitize, andownable/exts/authorizable.commondaois intentionally left out to keep the scope on the simpler packages.Continues the earlier draft #4817.