Skip to content

sample: bluetooth: Document Peer Manager section of samples - #823

Merged
eivindj-nordic merged 1 commit into
nrfconnect:mainfrom
PizzaAllTheWay:peer-manager-sample-doc
Aug 31, 2026
Merged

sample: bluetooth: Document Peer Manager section of samples#823
eivindj-nordic merged 1 commit into
nrfconnect:mainfrom
PizzaAllTheWay:peer-manager-sample-doc

Conversation

@PizzaAllTheWay

Copy link
Copy Markdown
Contributor

Add a short "Security" chapter to the README.rst of each relevant Bluetooth sample that integrates Peer Manager,
describing the configured pairing/bonding parameters and the security requirements of the sample's BLE services.
Samples with peer manager documentation:

  • ble_bms
  • ble_cgms
  • ble_hids_keyboard
  • ble_hids_mouse
  • ble_hrs
  • ble_hrs_central
  • peripheral_nfc_pairing

@PizzaAllTheWay PizzaAllTheWay self-assigned this Jul 27, 2026
@github-actions github-actions Bot added changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. doc-required PR must not be merged without tech writer approval. labels Jul 27, 2026
@PizzaAllTheWay
PizzaAllTheWay force-pushed the peer-manager-sample-doc branch from 030bddc to fecdcb7 Compare July 27, 2026 15:13
@PizzaAllTheWay
PizzaAllTheWay marked this pull request as ready for review July 27, 2026 15:13
@PizzaAllTheWay
PizzaAllTheWay requested a review from a team as a code owner July 27, 2026 15:13
@NordicBuilder
NordicBuilder requested a review from a team July 27, 2026 15:13
@github-actions

Copy link
Copy Markdown

You can find the documentation preview for this PR here.

@eivindj-nordic

Copy link
Copy Markdown
Contributor

Commit title prefix should be samples: bluetooth: as that is where the files changed are located.

Comment thread samples/bluetooth/ble_bms/README.rst Outdated
@PizzaAllTheWay
PizzaAllTheWay force-pushed the peer-manager-sample-doc branch from fecdcb7 to 083d9a2 Compare July 28, 2026 07:38
Comment thread samples/bluetooth/ble_bms/README.rst Outdated
Comment thread samples/bluetooth/ble_cgms/README.rst Outdated
@PizzaAllTheWay
PizzaAllTheWay force-pushed the peer-manager-sample-doc branch from 083d9a2 to bfc64ca Compare July 28, 2026 08:23
@PizzaAllTheWay
PizzaAllTheWay force-pushed the peer-manager-sample-doc branch from bfc64ca to 115316f Compare July 28, 2026 13:53
@eivindj-nordic eivindj-nordic added this to the v3.0.0 milestone Aug 6, 2026
@eivindj-nordic eivindj-nordic removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Aug 11, 2026

@b-gent b-gent left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

approving, pls fix the typo (appears 6 times)

Comment thread samples/bluetooth/ble_bms/README.rst Outdated
@PizzaAllTheWay
PizzaAllTheWay force-pushed the peer-manager-sample-doc branch from 115316f to 0018054 Compare August 14, 2026 13:27
@github-actions github-actions Bot added the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Aug 14, 2026
@PizzaAllTheWay
PizzaAllTheWay force-pushed the peer-manager-sample-doc branch from 0018054 to 506066f Compare August 14, 2026 13:27

@anhmolt anhmolt left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think we need better precision when explaining the security parameters. There is a slight difference to how they should be understood for a central and a peripheral.

See comments. They (probably) apply for all the sample README's in this PR.

Comment thread samples/bluetooth/ble_bms/README.rst Outdated
Comment thread samples/bluetooth/ble_bms/README.rst Outdated
Comment thread samples/bluetooth/ble_bms/README.rst Outdated
Comment thread samples/bluetooth/ble_bms/README.rst Outdated
Comment thread samples/bluetooth/ble_bms/README.rst Outdated
Comment thread samples/bluetooth/ble_bms/README.rst Outdated
Comment thread samples/bluetooth/ble_bms/README.rst Outdated
@PizzaAllTheWay
PizzaAllTheWay force-pushed the peer-manager-sample-doc branch from 506066f to e2ba6dd Compare August 17, 2026 09:54
Comment thread samples/bluetooth/ble_bms/README.rst
Comment thread samples/bluetooth/ble_cgms/README.rst Outdated
Comment thread samples/bluetooth/ble_cgms/README.rst Outdated
Comment thread samples/bluetooth/ble_bms/README.rst Outdated
Comment thread samples/bluetooth/ble_bms/README.rst Outdated
Comment thread samples/bluetooth/ble_hids_keyboard/README.rst Outdated
Comment thread samples/bluetooth/ble_hids_keyboard/README.rst Outdated
Comment thread samples/bluetooth/ble_hrs/README.rst Outdated
Comment thread samples/bluetooth/ble_hrs/README.rst Outdated
Comment thread samples/bluetooth/ble_hrs/README.rst Outdated
@PizzaAllTheWay
PizzaAllTheWay force-pushed the peer-manager-sample-doc branch 2 times, most recently from 800ee12 to 7ded0ab Compare August 18, 2026 17:02
@PizzaAllTheWay
PizzaAllTheWay requested a review from a team as a code owner August 18, 2026 17:02
@PizzaAllTheWay
PizzaAllTheWay force-pushed the peer-manager-sample-doc branch from 7ded0ab to 014313a Compare August 19, 2026 08:16
@eivindj-nordic
eivindj-nordic requested a review from anhmolt August 19, 2026 12:32

@anhmolt anhmolt left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good! Some follow up comments.

Comment thread samples/bluetooth/ble_cgms/README.rst Outdated
Comment thread samples/bluetooth/ble_hids_keyboard/README.rst Outdated
@PizzaAllTheWay
PizzaAllTheWay force-pushed the peer-manager-sample-doc branch from 014313a to 2f09e13 Compare August 19, 2026 15:01
@eivindj-nordic eivindj-nordic removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Aug 20, 2026
Comment thread samples/bluetooth/ble_hids_keyboard/README.rst Outdated
Add a short Security chapter to the README.rst of each relevant
Bluetooth sample that integrates Peer Manager,
describing the configured pairing/bonding parameters and the security
requirements of the sample's BLE services.
Samples with peer manager documentation:
- ble_bms
- ble_cgms
- ble_hids_keyboard
- ble_hids_mouse
- ble_hrs
- ble_hrs_central
- peripheral_nfc_pairing

Signed-off-by: Martynas Smilingis <martynas.smilingis@nordicsemi.no>
@anhmolt
anhmolt force-pushed the peer-manager-sample-doc branch from 2f09e13 to dae4cbf Compare August 26, 2026 11:49
@github-actions github-actions Bot added the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Aug 26, 2026
@eivindj-nordic eivindj-nordic removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Aug 31, 2026
@eivindj-nordic
eivindj-nordic merged commit 5ed6e89 into nrfconnect:main Aug 31, 2026
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc-required PR must not be merged without tech writer approval.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants