Feat improve exemples docs

[NestorDP]

Summary

• What does this PR do? Why is it needed?
• Link related issues (e.g., Closes #123)

Changes

• API changes
• Behavior changes
• Docs updated
• Tests added/updated

Details

• Briefly list the key changes and files touched

How to test

• Commands and steps to validate locally
• Include any environment requirements (Linux only, kernel version, etc.)

Screenshots/Logs (optional)

• Paste relevant output/logs if helpful

Checklist

• Builds locally (Release + Debug)
• All tests pass (if applicable)
• Lint/format pass: make cppcheck / make cpplint / make uncrustify
• Example(s) tested (if touched)
• Documentation updated (README/docs)

Risks and rollbacks

• Potential impact areas, and how to revert if needed

[Copilot]

Pull Request Overview

This PR updates the documentation to reflect API changes in the libserial library. The changes demonstrate a significant refactoring of the serial communication interface, moving from constructor-based port configuration to a more flexible open/configure pattern.

• Updated API usage patterns across all documentation examples
• Modified serial port initialization from constructor-based to separate open() calls
• Replaced old API methods with new equivalents (e.g., available() → getAvailableData(), setTimeout() → setReadTimeout())

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

File	Description
docs/usage.rst	Updated all code examples to use new API patterns including default constructors, explicit open() calls, and renamed methods
docs/examples.rst	Replaced example code with updated implementations, commented out outdated examples, and updated port discovery example
README.md	Reordered badge placement and commented out example application section

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

This line declares a function named serial that returns a libserial::Serial object (most vexing parse), not a Serial object instance. Remove the parentheses to create an instance: libserial::Serial serial;

Suggested change

	libserial::Serial serial();
	libserial::Serial serial;

[Copilot]

This line declares a function named serial that returns a libserial::Serial object (most vexing parse), not a Serial object instance. Remove the parentheses to create an instance: libserial::Serial serial;

[Copilot]

This line declares a function named serial that returns a libserial::Serial object (most vexing parse), not a Serial object instance. Remove the parentheses to create an instance: libserial::Serial serial;

Suggested change

	libserial::Serial serial();
	libserial::Serial serial;

[Copilot]

Off-by-one error in device count. If scanPorts() returns the count of ports found, adding 1 will show an incorrect count. This should likely be just num_ports without the + 1.

Suggested change

	std::cout << "Number of devices found: " << num_ports + 1 << std::endl;
	for (uint16_t i = 0; i <= num_ports; ++i) {
	std::cout << "Number of devices found: " << num_ports << std::endl;
	for (uint16_t i = 0; i < num_ports; ++i) {

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!