docs: fix broken APIs, wrong imports, and inaccurate compatibility info#283
Draft
docs: fix broken APIs, wrong imports, and inaccurate compatibility info#283
Conversation
Co-authored-by: rijesha <7819200+rijesha@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Review and validate documentation for clarity and completeness
docs: fix broken APIs, wrong imports, and inaccurate compatibility info
Mar 19, 2026
Contributor
|
@copilot do another pass to address the places that you have missed |
Co-authored-by: rijesha <7819200+rijesha@users.noreply.github.com>
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
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.
Documentation contained multiple broken code examples (non-existent modules, wrong method names, incorrect include paths) and factually wrong compatibility tables. Users following the docs would get import errors, compiler errors, or incorrect behavior.
Broken Python API references
struct_frame_parsermodule with actualframe_profilesimports acrossframing.mdx,framing-details.mdx,python-sdk.md,language-examples.mdxmsg.pack()→msg.serialize(),from_bytes()→deserialize(),to_bytes()→serialize()create_custom_profile()andget_profile(Profile.SENSOR)— replaced with actualProfileConfig/ProfileSensorWriter/ProfileSensorAccumulatingReaderAPIfrom generated.frame_profiles import ...→from frame_profiles import ...,from generated.example import ...→from struct_frame.generated.example import ...import array_test_sf→from struct_frame.generated.array_test import ...Broken C++ references
FrameProfiles.hpp→frame_profiles.hpp(actual filename, case-sensitive on Linux) — fixed in 5 filesusing namespace StructFrame→using namespace FrameParsersStructFrame::SDK→StructFrame::StructFrameSdk; fixedsubscribe()to requiremsgIdparam; removed non-existentprocess_byte()struct_frame_sdk/transports/serial.hpp→struct_frame_sdk/serial_transport.hppWrong C++ standard
installation.md,quick-start.md,testing.md,README.md) — the boilerplate usesrequiresexpressions which require C++20Inaccurate feature matrix (README)
✗across all features despite being fully supported with generated framing, serialization, enums, arrays, and nested messagesOther
docs/framing.mdlinks → live docs URLstruct_frame_sdk/→struct-frame-sdk/(hyphens match actual generated output)--validateand--debugflagsOriginal prompt
📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.