adds user guide docs#3215
Draft
rbolboac wants to merge 8 commits into
Draft
Conversation
Add the getting_started Sphinx guide: an end-to-end build/flash/debug/run walkthrough using the IIO Demo project and the no_os_build.py CMake flow. Wire it into the toctree. Assisted-by: Claude Opus 4.8 Signed-off-by: Ramona Gradinariu <ramona.gradinariu@analog.com>
Add the architecture Sphinx guide: the layer model, the platform_ops dispatch mechanism, and the init_param/descriptor idiom. Wire it into the toctree. Assisted-by: Claude Opus 4.8 Signed-off-by: Ramona Gradinariu <ramona.gradinariu@analog.com>
Add the iio_framework Sphinx guide: the IIO object model (device/channel/ attribute/buffer/trigger) and how a driver plugs into it. Wire it into the toctree. Assisted-by: Claude Opus 4.8 Signed-off-by: Ramona Gradinariu <ramona.gradinariu@analog.com>
Add the porting_guide Sphinx guide: adding a new platform (HAL implementation) or board. Wire it into the toctree. Assisted-by: Claude Opus 4.8 Signed-off-by: Ramona Gradinariu <ramona.gradinariu@analog.com>
Add the configuration_guide Sphinx guide: the Kconfig/defconfig layering and how it becomes config.cmake and no_os_config.h. Wire it into the toctree. Assisted-by: Claude Opus 4.8 Signed-off-by: Ramona Gradinariu <ramona.gradinariu@analog.com>
Add the troubleshooting Sphinx guide: common issues by workflow stage, plus an FAQ. Wire it into the toctree. Assisted-by: Claude Opus 4.8 Signed-off-by: Ramona Gradinariu <ramona.gradinariu@analog.com>
Update the WSL USB passthrough guide to the usbipd-win 4.0+ CLI: top-level list/bind/attach/detach with --wsl/--busid, and the required one-time bind step. Drop the obsolete in-WSL USB/IP client tooling install, which is no longer needed as of usbipd-win 4.0.0. Assisted-by: Claude Opus 4.8 Signed-off-by: Ramona Gradinariu <ramona.gradinariu@analog.com>
Clarify that the Git Bash / MSYS2 GCC prerequisites apply only to the legacy Makefile build; the CMake flow can be built from any console (cmake, ninja, python on PATH plus the vendor SDK). Assisted-by: Claude Opus 4.8 Signed-off-by: Ramona Gradinariu <ramona.gradinariu@analog.com>
rbolboac
requested review from
CiprianRegus,
RaduSabau1,
amiclaus,
buha,
cristina-suteu,
danmois,
dbogdan,
raezt,
ralucabozdog,
ranechita,
rbudai98 and
stefpopa
as code owners
July 15, 2026 13:04
rbolboac
marked this pull request as draft
July 15, 2026 13:04
Contributor
Author
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request Description
Please replace this with a detailed description and motivation of the changes.
You can tick the checkboxes below with an 'x' between square brackets or just check them after publishing the PR.
If this PR contains a breaking change, list dependent PRs and try to push all related PRs at the same time.
PR Type
PR Checklist