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: Doc fixes for 2.9 #19442

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

umapraseeda
Copy link
Contributor

Doc check and fixes for 2.9
NCSDK-30694

@umapraseeda umapraseeda added the backport v2.9-branch auto-create a PR with same commits to v2.9-branch label Dec 11, 2024
@umapraseeda umapraseeda added this to the 2.9.0 milestone Dec 11, 2024
@umapraseeda umapraseeda requested review from a team and annwoj as code owners December 11, 2024 14:25
@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 11, 2024
@NordicBuilder
Copy link
Contributor

NordicBuilder commented Dec 11, 2024

CI Information

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

Inputs:

Sources:

sdk-nrf: PR head: 1f4422e4ae3ac5b31d661f5b3e015453b544d8be

more details

sdk-nrf:

PR head: 1f4422e4ae3ac5b31d661f5b3e015453b544d8be
merge base: 4c6ab4d0e83046e0040f82a507bfd6826f0f4d9e
target head (main): 4c6ab4d0e83046e0040f82a507bfd6826f0f4d9e
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 (115)
applications
│  ├── asset_tracker_v2
│  │  ├── doc
│  │  │  ├── asset_tracker_v2_description.rst
│  │  │  ├── cloud_wrapper.rst
│  │  │  ├── data_module.rst
│  │  │  │ location_module.rst
│  ├── matter_bridge
│  │  ├── README.rst
│  │  ├── doc
│  │  │  ├── adding_ble_bridged_device_service.rst
│  │  │  ├── adding_bridged_matter_device.rst
│  │  │  ├── adding_bridged_protocol.rst
│  │  │  │ matter_bridge_description.rst
│  ├── matter_weather_station
│  │  │ README.rst
│  ├── nrf_desktop
│  │  ├── application_kconfig.rst
│  │  ├── bluetooth.rst
│  │  ├── board_configuration.rst
│  │  ├── doc
│  │  │  ├── bas.rst
│  │  │  ├── ble_adv.rst
│  │  │  ├── ble_passkey.rst
│  │  │  │ ble_qos.rst
│  ├── serial_lte_modem
│  │  ├── doc
│  │  │  ├── GNSS_AT_commands.rst
│  │  │  │ NRFCLOUD_AT_commands.rst
doc
│  ├── _utils
│  │  │ redirects.py
│  ├── _zoomin
│  │  │ ncs.tags.yml
│  ├── nrf
│  │  ├── app_dev
│  │  │  ├── bootloaders_dfu
│  │  │  │  ├── mcuboot_nsib
│  │  │  │  │  ├── bootloader_adding_sysbuild.rst
│  │  │  │  │  │ bootloader_quick_start.rst
│  │  │  ├── config_and_build
│  │  │  │  ├── cmake
│  │  │  │  │  │ index.rst
│  │  │  │  ├── sysbuild
│  │  │  │  │  │ sysbuild_images.rst
│  │  │  ├── device_guides
│  │  │  │  ├── fem
│  │  │  │  │  │ 21540ek_dev_guide.rst
│  │  │  │  ├── nrf54h
│  │  │  │  │  │ ug_nrf54h20_suit_customize_dfu.rst
│  │  │  │  ├── nrf54l
│  │  │  │  │  │ fota_update.rst
│  │  │  │  ├── nrf70
│  │  │  │  │  ├── power_profiling.rst
│  │  │  │  │  │ stack_partitioning.rst
│  │  │  │  ├── thingy53
│  │  │  │  │  ├── building_thingy53.rst
│  │  │  │  │  │ thingy53_application_guide.rst
│  │  │  │  │ wifi_coex.rst
│  │  ├── drivers
│  │  │  ├── wifi
│  │  │  │  │ nrf70_portable.rst
│  │  ├── external_comp
│  │  │  ├── avsystem.rst
│  │  │  │ nrf_cloud.rst
│  │  ├── glossary.rst
│  │  ├── includes
│  │  │  │ zigbee_deprecation.txt
│  │  ├── libraries
│  │  │  ├── bin
│  │  │  │  ├── lwm2m_carrier
│  │  │  │  │  │ msc.rst
│  │  │  ├── bluetooth
│  │  │  │  │ adv_prov.rst
│  │  │  ├── caf
│  │  │  │  ├── ble_adv.rst
│  │  │  │  ├── ble_bond.rst
│  │  │  │  │ ble_state.rst
│  │  │  ├── dfu
│  │  │  │  │ dfu_multi_image.rst
│  │  │  ├── gazell
│  │  │  │  │ gzp.rst
│  │  │  ├── modem
│  │  │  │  │ location.rst
│  │  │  ├── networking
│  │  │  │  ├── lwm2m_location_assistance.rst
│  │  │  │  ├── nrf_cloud.rst
│  │  │  │  ├── nrf_cloud_location.rst
│  │  │  │  ├── nrf_cloud_log.rst
│  │  │  │  ├── ot_rpc.rst
│  │  │  │  ├── wifi_credentials.rst
│  │  │  │  │ wifi_mgmt_ext.rst
│  │  │  ├── others
│  │  │  │  │ dm.rst
│  │  │  ├── security
│  │  │  │  │ fatal_error.rst
│  │  │  ├── zigbee
│  │  │  │  ├── zigbee_fota.rst
│  │  │  │  │ zigbee_zcl_scenes.rst
│  │  ├── links.txt
│  │  ├── protocols
│  │  │  ├── coexistence
│  │  │  │  │ index.rst
│  │  │  ├── gazell
│  │  │  │  │ gzll.rst
│  │  │  ├── matter
│  │  │  │  ├── end_product
│  │  │  │  │  ├── certification.rst
│  │  │  │  │  ├── ecosystems_certification.rst
│  │  │  │  │  │ security.rst
│  │  │  │  ├── getting_started
│  │  │  │  │  ├── adding_clusters.rst
│  │  │  │  │  ├── advanced_kconfigs.rst
│  │  │  │  │  ├── ecosystem_compatibility_testing.rst
│  │  │  │  │  ├── hw_requirements.rst
│  │  │  │  │  ├── index.rst
│  │  │  │  │  ├── low_power_configuration.rst
│  │  │  │  │  ├── matter_api.rst
│  │  │  │  │  ├── memory_optimization.rst
│  │  │  │  │  ├── testing
│  │  │  │  │  │  ├── index.rst
│  │  │  │  │  │  ├── thread_separate_otbr_linux_macos.rst
│  │  │  │  │  │  │ wifi_pc.rst
│  │  │  │  ├── index.rst
│  │  │  │  ├── overview
│  │  │  │  │  ├── architecture.rst
│  │  │  │  │  ├── commissioning.rst
│  │  │  │  │  ├── dev_model.rst
│  │  │  │  │  ├── integration.rst
│  │  │  │  │  │ network_topologies.rst
│  │  │  ├── thread
│  │  │  │  ├── overview
│  │  │  │  │  │ commissioning.rst
│  │  │  │  │ tools.rst
│  │  │  ├── wifi
│  │  │  │  ├── advanced_modes
│  │  │  │  │  ├── offloaded_raw_tx.rst
│  │  │  │  │  ├── promiscuous_operation.rst
│  │  │  │  │  ├── raw_tx_operation.rst
│  │  │  │  │  │ sniffer_rx_operation.rst
│  │  │  │  ├── station_mode
│  │  │  │  │  │ powersave.rst
│  │  ├── releases_and_maturity
│  │  │  ├── migration
│  │  │  │  ├── 2.4.99-cs3_to_2.6.99-cs2
│  │  │  │  │  │ migration_guide_2.4.99-cs3_to_2.6.99-cs2_application.rst
│  │  │  │  ├── migration_guide_2.7.rst
│  │  │  │  ├── nRF54H20_migration_2.7
│  │  │  │  │  │ migration_guide_2.4.99-cs3_to_2.7_application.rst
│  │  │  │ software_maturity.rst
│  │  ├── samples
│  │  │  ├── bl.rst
│  │  │  ├── matter.rst
│  │  │  │ wifi.rst
│  │  ├── test_and_optimize
│  │  │  ├── optimizing
│  │  │  │  ├── memory.rst
│  │  │  │  │ power_general.rst
samples
│  ├── bluetooth
│  │  ├── nrf_auraconfig
│  │  │  │ README.rst
│  │  ├── peripheral_hids_mouse
│  │  │  │ README.rst
│  ├── cellular
│  │  ├── location
│  │  │  │ README.rst
│  │  ├── lwm2m_client
│  │  │  │ sample_description.rst
│  │  ├── modem_shell
│  │  │  │ README.rst
│  │  ├── modem_trace_flash
│  │  │  │ README.rst
│  │  ├── nrf_cloud_multi_service
│  │  │  │ README.rst
│  │  ├── nrf_cloud_rest_cell_location
│  │  │  │ README.rst
│  ├── matter
│  │  ├── light_bulb
│  │  │  │ README.rst
│  │  ├── light_switch
│  │  │  │ README.rst
│  │  ├── lock
│  │  │  │ README.rst
│  │  ├── template
│  │  │  │ README.rst
│  │  ├── thermostat
│  │  │  │ README.rst
│  ├── net
│  │  ├── mqtt
│  │  │  ├── doc
│  │  │  │  ├── architecture.rst
│  │  │  │  │ description.rst
│  ├── nfc
│  │  ├── system_off
│  │  │  │ README.rst
│  ├── suit
│  │  ├── recovery
│  │  │  │ README.rst
│  ├── wifi
│  │  ├── softap
│  │  │  │ README.rst
│  │  ├── wfa_qt_app
│  │  │  │ README.rst

Outputs:

Toolchain

Version:
Build docker image:

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

  • ◻️ Toolchain
  • ◻️ Build twister
  • ◻️ Integration tests
    • ◻️ desktop52_verification
    • ◻️ test-fw-nrfconnect-ble_samples
    • ◻️ test-fw-nrfconnect-chip
    • ◻️ test-fw-nrfconnect-nfc
    • ◻️ test-fw-nrfconnect-nrf-iot_serial_lte_modem
    • ◻️ test-fw-nrfconnect-nrf-iot_zephyr_lwm2m
    • ◻️ test-fw-nrfconnect-nrf-iot_samples
    • ◻️ test-fw-nrfconnect-nrf-iot_thingy91
    • ◻️ test-fw-nrfconnect-nrf-iot_mosh
    • ◻️ test-fw-nrfconnect-nrf-iot_positioning
    • ◻️ test-sdk-wifi
    • ◻️ test-sdk-dfu
    • ⚠️ test-fw-nrfconnect-nrf-iot_cloud
    • ⚠️ test-sdk-dfu
Disabled integration tests
    • test_ble_nrf_config
    • test-fw-nrfconnect-apps
    • test-fw-nrfconnect-ble_mesh
    • test-fw-nrfconnect-boot
    • test-fw-nrfconnect-fem
    • test-fw-nrfconnect-nrf-iot_libmodem-nrf
    • test-fw-nrfconnect-nrf-iot_lwm2m
    • test-fw-nrfconnect-nrf-iot_nrf_provisioning
    • 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-find-my
    • test-sdk-mcuboot
    • test-sdk-pmic-samples
    • test-sdk-sidewalk
    • test-secdom-samples-public

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

samples/cellular/location/README.rst Outdated Show resolved Hide resolved
samples/suit/recovery/README.rst Outdated Show resolved Hide resolved
@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.

Doc check and fixes for 2.9

Signed-off-by: Uma Praseeda <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport v2.9-branch auto-create a PR with same commits to v2.9-branch 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.

3 participants