Skip to content

Docs v3 notes and pass#2503

Merged
julianoes merged 14 commits intomainfrom
pr-docs-pass
Feb 18, 2025
Merged

Docs v3 notes and pass#2503
julianoes merged 14 commits intomainfrom
pr-docs-pass

Conversation

@julianoes
Copy link
Copy Markdown
Collaborator

This adds v3 API changes and a general pass.

Still work in progress.

@@ -1,39 +1,39 @@
# mavsdk::Info::Identification Struct Reference
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't all this ref be updated/removed/modified by CI?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I'll look into that.

- TCP out (client): tcpout://remote_ip:port
```

For `tcp`, where we listen locally on that port, the IP can be set to:
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
For `tcp`, where we listen locally on that port, the IP can be set to:
For `tcpin`, where we listen locally on that port, the IP can be set to:

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

This is no longer needed as GitHub does it for us.
This automatically updates the markdown files in the docs/ dir if
generate_docs.sh is run with the argument --overwrite.
@julianoes julianoes marked this pull request as ready for review February 13, 2025 04:06
@julianoes
Copy link
Copy Markdown
Collaborator Author

@hamishwillee See my last commits. I've updated the reference and the script. Now vitepress complains but I don't understand why.

@julianoes
Copy link
Copy Markdown
Collaborator Author

@hamishwillee figured it out: mavlink/MAVSDK-Proto#368

@sonarqubecloud
Copy link
Copy Markdown

@julianoes
Copy link
Copy Markdown
Collaborator Author

Going to merge this and then do another pass.

@julianoes julianoes merged commit b4f133d into main Feb 18, 2025
42 of 43 checks passed
@julianoes julianoes deleted the pr-docs-pass branch February 18, 2025 06:17
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