Skip to content

Conversation

@kshivani06
Copy link
Contributor

@kshivani06 kshivani06 commented Jan 10, 2026

I have updated the documentation for --identity in the package reference guide to provide better clarity on valid inputs for different platforms.

  • Indicative Examples: Added examples for macOS (40-character SHA-1 hex strings/certificate names) and Windows (thumbprints/subject names) to show the "shape" of valid values.
  • Focused Content: Maintained a concise reference guide by linking directly to the platform-specific how-to guides for detailed signing instructions rather than duplicating them.
  • Path Verification: Verified that relative links correctly point to docs/en/how-to/code-signing/
  • Scope Management: Omitted any mention of distribution complexities or CI/GitHub Actions to keep the reference guide strictly focused on tool usage.

PR Checklist:

  • All new features have been tested
  • All new features have been documented
  • I have read the CONTRIBUTING.md file
  • I will abide by the code of conduct

Copy link
Member

@freakboy3742 freakboy3742 left a comment

Choose a reason for hiding this comment

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

Thanks - I've made some tweaks to your original draft, but this was a really helpful starting point.

For future reference, see the notes that I've left on the changenote file.

changes/2627.doc Outdated
Copy link
Member

Choose a reason for hiding this comment

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

A few details here for future reference:

  • A changenote file should not be empty
  • This should have a .md extension
  • In this case, it's probably a misc, not a doc. Yes, it's changing documentation; but the purpose of changenote files is to be a first draft of the release notes. A relatively minor (however valuable) addition to docs isn't something that really needs to be in the release notes of the next version.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the feedback and for the final tweaks! I've noted the point about using .misc for minor doc updates instead of .doc for future reference.

@freakboy3742 freakboy3742 merged commit 9802aa0 into beeware:main Jan 11, 2026
58 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants