Skip to content

docs(examples): add READMEs for p/nt packages#5950

Open
davd-gzl wants to merge 2 commits into
gnolang:masterfrom
davd-gzl:docs/nt-readmes
Open

docs(examples): add READMEs for p/nt packages#5950
davd-gzl wants to merge 2 commits into
gnolang:masterfrom
davd-gzl:docs/nt-readmes

Conversation

@davd-gzl

@davd-gzl davd-gzl commented Jul 13, 2026

Copy link
Copy Markdown
Member

Adds documentation for the p/nt packages, following a consistent format: summary, usage example, API reference, and notes. Three packages that had none get new READMEs: markdown/foreign, markdown/sanitize, and ownable/exts/authorizable.

commondao is intentionally left out to keep the scope on the simpler packages.

Continues the earlier draft #4817.

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.
@github-actions github-actions Bot added the 🧾 package/realm Tag used for new Realms or Packages. label Jul 13, 2026
@Gno2D2 Gno2D2 added the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Jul 13, 2026
@Gno2D2

Gno2D2 commented Jul 13, 2026

Copy link
Copy Markdown
Collaborator

🛠 PR Checks Summary

All Automated Checks passed. ✅

Manual Checks (for Reviewers):
  • IGNORE the bot requirements for this PR (force green CI check)
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)
🟢 Pending initial approval by a review team member, or review from tech-staff

☑️ Contributor Actions:
  1. Fix any issues flagged by automated checks.
  2. Follow the Contributor Checklist to ensure your PR is ready for review.
    • Add new tests, or document why they are unnecessary.
    • Provide clear examples/screenshots, if necessary.
    • Update documentation, if required.
    • Ensure no breaking changes, or include BREAKING CHANGE notes.
    • Link related issues/PRs, where applicable.
☑️ Reviewer Actions:
  1. Complete manual checks for the PR, including the guidelines and additional checks if applicable.
📚 Resources:
Debug
Automated Checks
Maintainers must be able to edit this pull request (more info)

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 The pull request was created from a fork (head branch repo: davd-gzl/gno)

Then

🟢 Requirement satisfied
└── 🟢 Maintainer can modify this pull request

Pending initial approval by a review team member, or review from tech-staff

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: ^master$
    └── 🟢 Not (🔴 Pull request author is a member of the team: tech-staff)

Then

🟢 Requirement satisfied
└── 🟢 If
    ├── 🟢 Condition
    │   └── 🟢 Or
    │       ├── 🟢 User notJoon already reviewed PR 5950 with state APPROVED
    │       ├── 🔴 At least 1 user(s) of the team tech-staff reviewed pull request
    │       └── 🔴 This pull request is a draft
    └── 🟢 Then
        └── 🟢 Not (🔴 This label is applied to pull request: review/triage-pending)

Manual Checks
**IGNORE** the bot requirements for this PR (force green CI check)

If

🟢 Condition met
└── 🟢 On every pull request

Can be checked by

  • Any user with comment edit permission

@davd-gzl davd-gzl changed the title docs(examples): rewrite and add READMEs for p/nt packages docs(examples): add READMEs for p/nt packages Jul 13, 2026
@davd-gzl
davd-gzl requested a review from alexiscolin July 13, 2026 15:39

@notJoon notJoon left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a few nits, but looks good to me 👍

Comment thread examples/gno.land/p/nt/avl/v0/README.md
Comment thread examples/gno.land/p/nt/uassert/v0/README.md Outdated
@Gno2D2 Gno2D2 removed the review/triage-pending PRs opened by external contributors that are waiting for the 1st review label Jul 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🧾 package/realm Tag used for new Realms or Packages.

Projects

Development

Successfully merging this pull request may close these issues.

3 participants