Skip to content

Conversation

@tcheeric
Copy link
Owner

Why now?

The supported NIP list only referenced numbers, making it hard to identify each proposal.
Related issue: #000

What changed?

  • Show each supported NIP's title alongside its number in the README.

BREAKING

  • n/a

Review focus

  • Accuracy of the NIP titles and links.

Checklist

  • Scope ≤ 300 lines (or split/stack)
  • Title is verb + object (e.g., “Refactor auth middleware to async”)
  • Description links the issue and answers “why now?”
  • BREAKING flagged if needed
  • Tests/docs updated (if relevant)

https://chatgpt.com/codex/tasks/task_b_68a728bc78a88331851aa6c901ed06e5

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR enhances the README documentation by adding descriptive titles alongside NIP numbers in the supported NIPs list, making it easier for developers to understand what each proposal covers without needing to follow individual links.

Key Changes

  • Added descriptive titles for all 23 supported NIPs in the README
  • Maintained existing link structure while improving readability

- [NIP-9](https://github.com/nostr-protocol/nips/blob/master/09.md) - Event Deletion Request
- [NIP-12](https://github.com/nostr-protocol/nips/blob/master/12.md) - Generic Tag Queries
- [NIP-14](https://github.com/nostr-protocol/nips/blob/master/14.md) - Subject tag in Text events
- [NIP-15](https://github.com/nostr-protocol/nips/blob/master/15.md) - Nostr Marketplace
Copy link

Copilot AI Aug 21, 2025

Choose a reason for hiding this comment

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

The title should be 'Nostr Marketplace (for peer-to-peer marketplaces)' to match the official NIP-15 title format which includes the descriptive parenthetical.

Suggested change
- [NIP-15](https://github.com/nostr-protocol/nips/blob/master/15.md) - Nostr Marketplace
- [NIP-15](https://github.com/nostr-protocol/nips/blob/master/15.md) - Nostr Marketplace (for peer-to-peer marketplaces)

Copilot uses AI. Check for mistakes.
- [NIP-46](https://github.com/nostr-protocol/nips/blob/master/46.md) - Nostr Remote Signing
- [NIP-57](https://github.com/nostr-protocol/nips/blob/master/57.md) - Lightning Zaps
- [NIP-60](https://github.com/nostr-protocol/nips/blob/master/60.md) - Cashu Wallets
- [NIP-61](https://github.com/nostr-protocol/nips/blob/master/61.md) - Nutzaps
Copy link

Copilot AI Aug 21, 2025

Choose a reason for hiding this comment

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

The title should be 'Nut Zaps' (two words) to match the official NIP-61 title format.

Suggested change
- [NIP-61](https://github.com/nostr-protocol/nips/blob/master/61.md) - Nutzaps
- [NIP-61](https://github.com/nostr-protocol/nips/blob/master/61.md) - Nut Zaps

Copilot uses AI. Check for mistakes.
@codecov-commenter
Copy link

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@tcheeric tcheeric merged commit 9e368be into develop Aug 21, 2025
2 of 3 checks passed
@tcheeric tcheeric deleted the codex/add-nip-title-to-stopped-nips-list branch August 21, 2025 14:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants