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

Add device and board documentation to cbuild.yml #1871

Open
brondani opened this issue Nov 27, 2024 · 1 comment
Open

Add device and board documentation to cbuild.yml #1871

brondani opened this issue Nov 27, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@brondani
Copy link
Collaborator

brondani commented Nov 27, 2024

Requested by @edriouk

The device and board documentation described in DFPs and BSPs book sections should be added to cbuild.yml.

PDSC specification:
https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/pdsc_family_pg.html#element_book
https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/pdsc_boards_pg.html#element_board_book

Example of yml nodes:

build:
  device-books:
    - name: https://developer.arm.com/documentation/dui0662
      title: Cortex-M0+ Processor Devices Generic Users Guide
  board-books:
    - category: manual
      name: https://www.st.com/resource/en/user_manual/um2839-discovery-kit-for-iot-node-with-stm32u5-series-stmicroelectronics.pdf
      title: User Manual
    - category: other
      name: ${CMSIS_PACK_ROOT}/Keil/B-U585I-IOT02A_BSP/2.0.0/Documents/README.md
      title: Guide
@brondani brondani added the enhancement New feature or request label Nov 27, 2024
@brondani brondani self-assigned this Nov 27, 2024
@brondani brondani moved this to Backlog in CMSIS-Toolbox 2.7.0 Nov 27, 2024
@brondani brondani moved this from Backlog to In progress in CMSIS-Toolbox 2.7.0 Nov 29, 2024
@brondani brondani moved this from In progress to In review in CMSIS-Toolbox 2.7.0 Dec 2, 2024
@brondani brondani moved this from In review to Done in CMSIS-Toolbox 2.7.0 Dec 2, 2024
@brondani brondani closed this as completed by moving to Done in CMSIS-Toolbox 2.7.0 Dec 2, 2024
@brondani
Copy link
Collaborator Author

brondani commented Dec 5, 2024

@ReinhardKeil Please consider adding the new nodes device-books and board-books into the documentation.

@brondani brondani reopened this Dec 5, 2024
@brondani brondani assigned ReinhardKeil and unassigned brondani Dec 5, 2024
@jkrech jkrech added the documentation Improvements or additions to documentation label Dec 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Status: Done
Development

No branches or pull requests

3 participants