Docs v3 notes and pass #2503
Merged
Docs v3 notes and pass #2503
Conversation
This file contains 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
hamishwillee
reviewed
Feb 5, 2025
| @@ -1,39 +1,39 @@ | |||
| # mavsdk::Info::Identification Struct Reference | |||
There was a problem hiding this comment.
Shouldn't all this ref be updated/removed/modified by CI?
There was a problem hiding this comment.
Yes, I'll look into that.
hamishwillee
reviewed
Feb 5, 2025
docs/en/cpp/api_changes.md
Outdated
| - TCP out (client): tcpout://remote_ip:port | ||
| ``` | ||
|
|
||
| For `tcp`, where we listen locally on that port, the IP can be set to: |
There was a problem hiding this comment.
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: |
This is no longer needed as GitHub does it for us.
More to come...
This automatically updates the markdown files in the docs/ dir if generate_docs.sh is run with the argument --overwrite.
julianoes
force-pushed
the
pr-docs-pass
branch
from
9eda63d to
c78684a
Compare
|
@hamishwillee See my last commits. I've updated the reference and the script. Now vitepress complains but I don't understand why. |
|
@hamishwillee figured it out: mavlink/MAVSDK-Proto#368 |
This is with all the fixes and updated docstrings.
|
|
Going to merge this and then do another pass. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This adds v3 API changes and a general pass.
Still work in progress.