Skip to content

docs: fix broken APIs, wrong imports, and inaccurate compatibility info#283

Draft
Copilot wants to merge 3 commits intodevelopfrom
copilot/validate-documentation-completeness
Draft

docs: fix broken APIs, wrong imports, and inaccurate compatibility info#283
Copilot wants to merge 3 commits intodevelopfrom
copilot/validate-documentation-completeness

Conversation

Copy link
Contributor

Copilot AI commented Mar 19, 2026

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

  • Replaced all references to non-existent struct_frame_parser module with actual frame_profiles imports across framing.mdx, framing-details.mdx, python-sdk.md, language-examples.mdx
  • Fixed msg.pack()msg.serialize(), from_bytes()deserialize(), to_bytes()serialize()
  • Removed non-existent create_custom_profile() and get_profile(Profile.SENSOR) — replaced with actual ProfileConfig/ProfileSensorWriter/ProfileSensorAccumulatingReader API
  • Fixed import paths: from generated.frame_profiles import ...from frame_profiles import ..., from generated.example import ...from struct_frame.generated.example import ...
  • Fixed import array_test_sffrom struct_frame.generated.array_test import ...

Broken C++ references

  • FrameProfiles.hppframe_profiles.hpp (actual filename, case-sensitive on Linux) — fixed in 5 files
  • using namespace StructFrameusing namespace FrameParsers
  • SDK: StructFrame::SDKStructFrame::StructFrameSdk; fixed subscribe() to require msgId param; removed non-existent process_byte()
  • Transport includes: struct_frame_sdk/transports/serial.hppstruct_frame_sdk/serial_transport.hpp

Wrong C++ standard

  • C++14/C++17 → C++20 throughout (installation.md, quick-start.md, testing.md, README.md) — the boilerplate uses requires expressions which require C++20

Inaccurate feature matrix (README)

  • C# was marked across all features despite being fully supported with generated framing, serialization, enums, arrays, and nested messages

Other

  • Broken docs/framing.md links → live docs URL
  • TypeScript SDK folder: struct_frame_sdk/struct-frame-sdk/ (hyphens match actual generated output)
  • CLI reference: added missing --validate and --debug flags
Original prompt

go through the documentation and validate that it is complete, clear, concise and easy to follow


📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.

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
Copilot AI requested a review from rijesha March 19, 2026 01:51
@rijesha
Copy link
Contributor

rijesha commented Mar 19, 2026

@copilot do another pass to address the places that you have missed

Co-authored-by: rijesha <7819200+rijesha@users.noreply.github.com>
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