Skip to content

Mhirsch-wip #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 13 commits into
base: main
Choose a base branch
from
Open

Mhirsch-wip #32

wants to merge 13 commits into from

Conversation

michellehirsch
Copy link
Member

README.md Updates for ease of use, new features, and slight changes to recommendations.

Ease of use:

  • Summary of recommended folder structure near top of document.
  • Link to exemplar repos at bottom of document

New features:

  • Updated discussion of Toolbox Packaging to include Project-based workflow introduced in R2025a, in addition to Toolbox Packaging Tool-based workflow for prior releases.

Updates to recommendations:

  • Use private folder instead of internal, since naming a folder internal doesn't communicate to end user that code should not be called.
  • Updated gettingStarted.mlx to GettingStarted.mlx, for consistency with MathWorks naming standards for examples.

@michellehirsch
updated gettingStarted.mlx to GettingStarted.mlx. Clarified name of R…
89bd852 
…oot Folder section

First pass of updates:
* updated gettingStarted.mlx to GettingStarted.mlx to math standard that example files use Upper Camelcase Names
* Renamed Root Folder to Root Folder Name and Contents to set a clearer expectation of what would be included.
@michellehirsch
Added draft tldr, with hints of suggested changes to the standards
5990737
@michellehirsch
Update README.md
aaa0017 
Starting to work on updates for 25a toolbox packaging workflow.
@michellehirsch
Added examples. Updated toolbox packaging to include 25a workflow.
a82c4d4
@michellehirsch
replaced advice to use internal folder with private folder, so it act…
67546a4 
…ually keeps functions off of the path
@michellehirsch
Fixed and fleshed out recommendations on private folder and internal …
616ddf1 
…namespace.
This was referenced Jun 18, 2025
Open
Open
@rpurser47
Copy link
Member

rpurser47 commented Jun 19, 2025 •
edited
Loading

@michellehirsch Per our in-person conversation:

  1. Move the TL;DR work into a separate branch and remove from Mhirsch-wip #32.
  2. Agree that we should move toolbox/gettingStarted.mlx to toolbox/doc/GettingStarted.mlx. Note that we'll have to update the buildfile.txt in arithmetic to remove the workaround that handles it.
  3. Adopt solution proposed in "internal" folder doesn't achieve it's desired objectives #31

@rpurser47
Copy link
Member

rpurser47 commented Jun 19, 2025 •
edited
Loading

@rpurser47 and @bpancras to review the proposed R2025a project based toolbox packaging workflow recommendation.

This was linked to issues Jun 19, 2025
"internal" folder doesn't achieve it's desired objectives #31
Open
gettingStarted.mlx should be GettingStarted.mlx #26
Open
@michellehirsch
Copy link
Member Author

Addressed Rob's feedback.

@michellehirsch michellehirsch requested a review from rpurser47 June 19, 2025 20:08
rpurser47
rpurser47 reviewed Jun 20, 2025
View reviewed changes
rpurser47
rpurser47 requested changes Jun 20, 2025
View reviewed changes
michellehirsch
michellehirsch commented Jun 23, 2025
View reviewed changes
Copy link
Member Author

@michellehirsch michellehirsch left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Change of intro to use doc/GettingStarted.mlx looks good

michellehirsch
michellehirsch commented Jun 23, 2025
View reviewed changes
Copy link
Member Author

@michellehirsch michellehirsch left a comment

Choose a reason for hiding this comment

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

Have made all requested changes. Ready for @rpurser47 to review again.

@michellehirsch michellehirsch requested a review from rpurser47 June 23, 2025 18:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bpancras bpancras bpancras left review comments

@rpurser47 rpurser47 Awaiting requested review from rpurser47

Requested changes must be addressed to merge this pull request.

Assignees

@michellehirsch michellehirsch

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

"internal" folder doesn't achieve it's desired objectives gettingStarted.mlx should be GettingStarted.mlx
3 participants
@michellehirsch @rpurser47 @bpancras