Skip to content

Comments

docs: update docs from GitLab#1

Merged
brent-sink merged 17 commits intomainfrom
updates-from-gitlab
Jan 23, 2026
Merged

docs: update docs from GitLab#1
brent-sink merged 17 commits intomainfrom
updates-from-gitlab

Conversation

@brent-sink
Copy link
Contributor

No description provided.

@brent-sink brent-sink requested a review from Pertempto January 22, 2026 23:28
@github-actions
Copy link

@brent-sink — PR title does not follow the repo's conventional commit style. Please rename the PR to a conventional format (example: docs: update docs from GitLab or chore: sync from gitlab).

@github-actions
Copy link

@brent-sink — In src/content/docs/hardware/inputs-outputs.mdx the spidev_test code block contains trailing literal n characters inside the quoted bytes: "\x20\x01\x00\x00\x00"n. That looks like a typo and will cause confusion. Please remove the trailing n so the example reads "\x20\x01\x00\x00\x00" and "\x20\x05\x00\x00\x00".

@github-actions
Copy link

@brent-sink — In src/content/docs/operating-system/multimedia.mdx you added an /etc/asound.conf example. The file looks fine, but please confirm the channel mapping comment (lines ~88-89) — you say "channel 0 is re-routed to channel 6" but the ttable shows ttable.0.6 = 0.25 (source channel 0 -> destination 6), which is consistent; just confirm that's intentionally zero-based in the comment to avoid confusion for readers.

@github-actions
Copy link

Changes Requested

Please address the following before I re-review:

  • Rename the PR title to follow conventional commit style (example: docs: update docs from GitLab or chore: sync from gitlab).
  • Fix the spidev_test examples in src/content/docs/hardware/inputs-outputs.mdx by removing the stray trailing n in the quoted byte strings (should be "\x20\x01\x00\x00\x00").
  • Verify the Yocto/url and artifact name changes in src/content/docs/yocto/building-yocto.mdx and src/content/docs/yocto/flashing.mdx:
    • Confirm the default backend np-imx-wayland and the image name neuralplex-image-imx8qm-np-rootfs.wic are correct for your builds.
    • Confirm imx-boot is the intended UUU bootloader component used with sudo uuu -b emmc_all.
  • Clarify the channel mapping comment in src/content/docs/operating-system/multimedia.mdx so readers understand the ttable mapping is zero-based (or reword to remove ambiguity).

Summary of Changes

  • Documentation updates across several docs:
    • src/content/docs/hardware/inputs-outputs.mdx — added spidev_test examples (contains a typo).
    • src/content/docs/operating-system/multimedia.mdx — added /etc/asound.conf audio routing example.
    • src/content/docs/operating-system/serdes.mdx — updates to SerDes pattern generation script (I2C passthrough / DSI enable).
    • src/content/docs/other/release-notes.mdx — bumped versions and release notes.
    • src/content/docs/yocto/building-yocto.mdx and src/content/docs/yocto/flashing.mdx — switched repo URLs to HTTPS and updated build/flashing commands and artifact names.
    • package-lock.json — removed several "peer": true entries in multiple dependency sections.

Overall Feedback

  • Negative: Several small but important issues remain (PR title not conventional, a clear typo in the spidev_test examples, and potentially breaking/incorrect Yocto/flashing command or artifact name changes). These could confuse readers or cause users to run incorrect commands. Please address the requested fixes above.

  • Positive: The changes improve the docs with useful examples (audio routing, SPI test commands, SerDes scripts) and bring Yocto instructions and release notes up to date. Nice work consolidating these docs — once the small fixes are applied this will be much more helpful to users. 👍

I left inline review comments on the relevant files — please update and I will re-check.

@brent-sink brent-sink changed the title Updates from gitlab docs: update docs from GitLab Jan 22, 2026
@brent-sink brent-sink merged commit fce4118 into main Jan 23, 2026
1 check passed
@brent-sink brent-sink deleted the updates-from-gitlab branch January 23, 2026 20:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants