Skip to content

Docs/tutorial fixes#692

Merged
ad3154 merged 4 commits into
Open-Agriculture:mainfrom
sujandumaru:docs/tutorial-fixes
Jun 1, 2026
Merged

Docs/tutorial fixes#692
ad3154 merged 4 commits into
Open-Agriculture:mainfrom
sujandumaru:docs/tutorial-fixes

Conversation

@sujandumaru

Copy link
Copy Markdown
Contributor

Describe your changes

While reviewing the tutorials, I found several minor typos, malformed RST markup, and some code that could confuse readers. This PR fixes those tutorial issues and also updates the PGN Requests tutorial to match the current API.

  • Clarifies create_internal_control_function preferred-address usage in the ISOBUS Hello World tutorial.
  • Fixes minor tutorial typos and malformed RST markup.
  • Updates the PGN Requests tutorial to use the current PGN request protocol API:
    • removes references to deleted protocol assignment/getter APIs
    • uses internalECU->get_pgn_request_protocol().lock()
    • fixes callback signatures and std::shared_ptr namespace usage
    • adds complete callback return paths in snippets
  • Fixes the ESP32 PlatformIO link markup warning so the Sphinx build is warning-free.

Attempts to fix #514 at the same time.

How has this been tested?

Ran the documentation build locally after installing the Sphinx requirements and generating Doxygen XML.

python3 -m venv /docs-build
/docs-build/bin/pip install -r sphinx/requirements.txt

doxygen doxyfile

cd sphinx
/docs-build/bin/sphinx-build -M html source build -E -a

@ad3154 ad3154 added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 1, 2026
@ad3154
ad3154 merged commit 8ae63d6 into Open-Agriculture:main Jun 1, 2026
10 checks passed
@sujandumaru
sujandumaru deleted the docs/tutorial-fixes branch June 1, 2026 03:17
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

None yet

Development

Successfully merging this pull request may close these issues.

Update documentation after the removal of assign_pgn_request_protocol_to_internal_control_function

2 participants