Skip to content

Align README with MATLAB repo structure#51

Merged
iahncajigas merged 2 commits intomainfrom
docs/readme-matlab-parity
Mar 10, 2026
Merged

Align README with MATLAB repo structure#51
iahncajigas merged 2 commits intomainfrom
docs/readme-matlab-parity

Conversation

@iahncajigas
Copy link
Copy Markdown
Contributor

Summary

  • Added three extended description paragraphs matching MATLAB README (key strengths with SSGLM/UKF/hybrid mention, generic applicability, open-source contribution invitation)
  • Expanded Paper-Aligned Toolbox Map section with SSGLM workflow (Section 2.4), decoding details (Sections 2.5-2.6), and signal processing methods
  • Added MATLAB Toolbox section (mirrors the MATLAB repo's "Python port" section)
  • Reorganized Data and Related Repositories section
  • Fixed missing blank line before Documentation heading

Test plan

  • Docs build passes
  • All CI checks pass

🤖 Generated with Claude Code

Iahn Cajigas and others added 2 commits March 10, 2026 00:34
- Add three extended description paragraphs matching MATLAB README
  (key strengths, generic applicability, open-source contribution invite)
- Expand Paper-Aligned Toolbox Map with SSGLM workflow (Section 2.4),
  decoding details (Sections 2.5-2.6), and signal processing methods
- Add MATLAB Toolbox section mirroring MATLAB repo's Python port section
- Reorganize Data and Related Repositories to list Figshare/DOI first
- Fix missing blank line before Documentation heading

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Remove extra blank line before ## Documentation that caused
test_readme_examples_block_matches_generator to fail — the extracted
examples block must match the generator output exactly.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@iahncajigas iahncajigas merged commit b069deb into main Mar 10, 2026
13 checks passed
@iahncajigas iahncajigas deleted the docs/readme-matlab-parity branch March 11, 2026 18:55
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.

1 participant