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: improvements to nRF Desktop and CAF documentation #19719

Merged
merged 1 commit into from
Jan 22, 2025

Conversation

peknis
Copy link
Contributor

@peknis peknis commented Dec 30, 2024

Making configuration steps clearer.
Also other minor fixes.

NCSDK-30075

@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 30, 2024
@peknis peknis added the CI-disable Disable CI for this PR label Dec 30, 2024
@NordicBuilder
Copy link
Contributor

NordicBuilder commented Dec 30, 2024

CI Information

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

Inputs:

Sources:

more details

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 (0)

Outputs:

Toolchain

Version:
Build docker image:

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

  • ◻️ Toolchain
  • ◻️ Build twister
  • ◻️ Integration tests

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

@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.

@peknis peknis force-pushed the dt_caf_fixes branch 4 times, most recently from 967a8c1 to e261d34 Compare January 2, 2025 09:20
@peknis peknis marked this pull request as ready for review January 2, 2025 10:38
@peknis peknis requested review from a team as code owners January 2, 2025 10:38
@peknis peknis requested review from MarekPieta and kapi-no January 2, 2025 10:38
applications/nrf_desktop/doc/ble_qos.rst Outdated Show resolved Hide resolved
applications/nrf_desktop/doc/ble_scan.rst Outdated Show resolved Hide resolved
applications/nrf_desktop/doc/cpu_meas.rst Outdated Show resolved Hide resolved
applications/nrf_desktop/doc/hid_state.rst Outdated Show resolved Hide resolved
applications/nrf_desktop/doc/passkey.rst Outdated Show resolved Hide resolved
applications/nrf_desktop/doc/wheel.rst Outdated Show resolved Hide resolved
doc/nrf/libraries/caf/ble_bond.rst Outdated Show resolved Hide resolved
doc/nrf/libraries/caf/sensor_manager.rst Outdated Show resolved Hide resolved
applications/nrf_desktop/doc/hid_forward.rst Outdated Show resolved Hide resolved
applications/nrf_desktop/doc/hids.rst Outdated Show resolved Hide resolved
applications/nrf_desktop/doc/hids.rst Outdated Show resolved Hide resolved
applications/nrf_desktop/doc/swift_pair_app.rst Outdated Show resolved Hide resolved
doc/nrf/libraries/caf/net_state.rst Outdated Show resolved Hide resolved
doc/nrf/libraries/caf/power_manager.rst Outdated Show resolved Hide resolved
doc/nrf/libraries/caf/sensor_data_aggregator.rst Outdated Show resolved Hide resolved
doc/nrf/libraries/caf/sensor_manager.rst Outdated Show resolved Hide resolved
doc/nrf/libraries/caf/sensor_manager.rst Outdated Show resolved Hide resolved
@peknis peknis requested a review from MarekPieta January 22, 2025 13:13
@peknis peknis force-pushed the dt_caf_fixes branch 2 times, most recently from a57ea3b to e7467bb Compare January 22, 2025 13:36
Copy link
Contributor

@mkapala-nordic mkapala-nordic left a comment

Choose a reason for hiding this comment

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

Overall LGTM.
I am not sure if not adding "Kconfig" before "option" in following places is intentional, but just in case i marked those places (I think that in most cases there is full "Kconfig option" instead of just "option").
Can be ignored if intentional :D

applications/nrf_desktop/doc/cpu_meas.rst Show resolved Hide resolved
doc/nrf/libraries/caf/ble_adv.rst Show resolved Hide resolved
doc/nrf/libraries/caf/ble_bond.rst Show resolved Hide resolved
doc/nrf/libraries/caf/net_state.rst Show resolved Hide resolved
doc/nrf/libraries/caf/power_manager.rst Show resolved Hide resolved
doc/nrf/libraries/caf/ble_state_pm.rst Outdated Show resolved Hide resolved
applications/nrf_desktop/doc/ble_qos.rst Outdated Show resolved Hide resolved
Making configuration steps clearer.
Also other minor fixes.

NCSDK-30075

Signed-off-by: Pekka Niskanen <[email protected]>
@rlubos rlubos merged commit 7feff67 into nrfconnect:main Jan 22, 2025
13 checks passed
@peknis peknis deleted the dt_caf_fixes branch January 22, 2025 14:24
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. CI-disable Disable CI for this PR doc-required PR must not be merged without tech writer approval.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants