Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: nrf: bluetooth: RAS RREQ and RRSP docs #19230

Merged
merged 2 commits into from
Dec 4, 2024

Conversation

weeTike
Copy link
Contributor

@weeTike weeTike commented Dec 3, 2024

This adds documentation for the Ranging Service Ranging Responder and Ranging Requestor.

@weeTike weeTike requested review from a team as code owners December 3, 2024 16:05
@github-actions github-actions bot added doc-required PR must not be merged without tech writer approval. changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. labels Dec 3, 2024
@NordicBuilder
Copy link
Contributor

You can find the documentation preview for this PR at this link. It will be updated about 10 minutes after the documentation build succeeds.

Note: This comment is automatically posted by the Documentation Publish GitHub Action.

@weeTike weeTike force-pushed the ras_rreq_and_rrsp_docs branch from d0d2bbc to 5c87cf6 Compare December 3, 2024 16:34
@NordicBuilder
Copy link
Contributor

NordicBuilder commented Dec 3, 2024

CI Information

To view the history of this post, clich the 'edited' button above
Build number: 4

Inputs:

Sources:

sdk-nrf: PR head: e3a1b1abc3499875be1bb844b282084cebf2fd3f

more details

sdk-nrf:

PR head: e3a1b1abc3499875be1bb844b282084cebf2fd3f
merge base: 09228a59365ab09daab2c6050044d6c9cf065ea1
target head (main): cf777d12ccf26adb208b7d63fa157b7bb243d1dd
Diff

Github labels

Enabled Name Description
ci-disabled Disable the ci execution
ci-all-test Run all of ci, no test spec filtering will be done
ci-force-downstream Force execution of downstream even if twister fails
ci-run-twister Force run twister
ci-run-zephyr-twister Force run zephyr twister
List of changed files detected by CI (3)
doc
│  ├── nrf
│  │  ├── libraries
│  │  │  ├── bluetooth
│  │  │  │  ├── services
│  │  │  │  │  ├── rreq.rst
│  │  │  │  │  │ rrsp.rst
│  │  │ links.txt

Outputs:

Toolchain

Version:
Build docker image:

Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped; ⚠️ Quarantine

  • ◻️ Toolchain
  • ◻️ Build twister
  • ◻️ Integration tests
Disabled integration tests
    • desktop52_verification
    • doc-internal
    • test_ble_nrf_config
    • test-fw-nrfconnect-apps
    • test-fw-nrfconnect-ble_mesh
    • test-fw-nrfconnect-ble_samples
    • test-fw-nrfconnect-boot
    • test-fw-nrfconnect-chip
    • test-fw-nrfconnect-fem
    • test-fw-nrfconnect-nfc
    • test-fw-nrfconnect-nrf-iot_libmodem-nrf
    • test-fw-nrfconnect-nrf-iot_lwm2m
    • test-fw-nrfconnect-nrf-iot_mosh
    • test-fw-nrfconnect-nrf-iot_nrf_provisioning
    • test-fw-nrfconnect-nrf-iot_positioning
    • test-fw-nrfconnect-nrf-iot_samples
    • test-fw-nrfconnect-nrf-iot_serial_lte_modem
    • test-fw-nrfconnect-nrf-iot_thingy91
    • test-fw-nrfconnect-nrf-iot_zephyr_lwm2m
    • test-fw-nrfconnect-nrf_crypto
    • test-fw-nrfconnect-ps
    • test-fw-nrfconnect-rpc
    • test-fw-nrfconnect-rs
    • test-fw-nrfconnect-tfm
    • test-fw-nrfconnect-thread
    • test-fw-nrfconnect-zigbee
    • test-low-level
    • test-sdk-audio
    • test-sdk-dfu
    • test-sdk-find-my
    • test-sdk-mcuboot
    • test-sdk-pmic-samples
    • test-sdk-sidewalk
    • test-sdk-wifi
    • test-secdom-samples-public

Note: This message is automatically posted and updated by the CI

doc/nrf/libraries/bluetooth/services/rreq.rst Outdated Show resolved Hide resolved
doc/nrf/libraries/bluetooth/services/rreq.rst Outdated Show resolved Hide resolved
doc/nrf/libraries/bluetooth/services/rreq.rst Outdated Show resolved Hide resolved
doc/nrf/libraries/bluetooth/services/rreq.rst Outdated Show resolved Hide resolved
doc/nrf/libraries/bluetooth/services/rreq.rst Outdated Show resolved Hide resolved
doc/nrf/libraries/bluetooth/services/rreq.rst Outdated Show resolved Hide resolved
doc/nrf/libraries/bluetooth/services/rreq.rst Outdated Show resolved Hide resolved
doc/nrf/libraries/bluetooth/services/rreq.rst Outdated Show resolved Hide resolved
doc/nrf/libraries/bluetooth/services/rrsp.rst Outdated Show resolved Hide resolved
doc/nrf/libraries/bluetooth/services/rrsp.rst Show resolved Hide resolved
@weeTike weeTike force-pushed the ras_rreq_and_rrsp_docs branch from 5c87cf6 to fd67cf6 Compare December 4, 2024 10:51
@weeTike weeTike requested a review from a team as a code owner December 4, 2024 10:51
@github-actions github-actions bot removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Dec 4, 2024
@weeTike weeTike requested a review from peknis December 4, 2024 11:14
Copy link
Contributor

@nordicjm nordicjm left a comment

Choose a reason for hiding this comment

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

commit should be lowercase for the areas and not have subsys and have the right area e.g. doc: nrf: bluetooth: Add documentation for RREQ

@weeTike weeTike force-pushed the ras_rreq_and_rrsp_docs branch from fd67cf6 to 38f85b3 Compare December 4, 2024 12:04
@weeTike weeTike changed the title Subsys: Bluetooth: RAS RREQ and RRSP docs doc: nrf: bluetooth: RAS RREQ and RRSP docs Dec 4, 2024
@weeTike weeTike added this to the 2.9.0 milestone Dec 4, 2024
This adds documentation for the Ranging service Ranging Requestor.

Signed-off-by: Timothy Keys <[email protected]>
This adds documentation for the Ranging Service Ranging Responder.

Signed-off-by: Timothy Keys <[email protected]>
@weeTike weeTike force-pushed the ras_rreq_and_rrsp_docs branch from 38f85b3 to e3a1b1a Compare December 4, 2024 14: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 Dec 4, 2024
@weeTike weeTike requested a review from peknis December 4, 2024 15:08
Configuration
*************

To enable this library, use the :kconfig:option:`CONFIG_BT_RAS` Kconfig option.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
To enable this library, use the :kconfig:option:`CONFIG_BT_RAS` Kconfig option.
To enable this library, use the :kconfig:option:`CONFIG_BT_RAS` and :kconfig:option:`CONFIG_BT_RAS_RREQ` Kconfig options.

Maybe this makes more sense

@carlescufi carlescufi merged commit 2d93fda into nrfconnect:main Dec 4, 2024
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants