Skip to content

Add autogen for AMDC article in control with AMDC folder - #151

Open
Daehoon-Sung wants to merge 135 commits into
mainfrom
feature/add-autogen-control-with-AMDC-article
Open

Add autogen for AMDC article in control with AMDC folder#151
Daehoon-Sung wants to merge 135 commits into
mainfrom
feature/add-autogen-control-with-AMDC-article

Conversation

@Daehoon-Sung

@Daehoon-Sung Daehoon-Sung commented Mar 19, 2026

Copy link
Copy Markdown
Contributor

This is to close #143 to close #149 to close https://github.com/Severson-Group/AMDC-Examples/issues/6.

Notes

This comment might be useful to refer to how we came up with the plan for those two ariticles.

Self-Review

In this section, please self-review (answer all questions) on a suitable review checklist prior to requesting review from others. Select a review checklist based on what content is being merged in; see the Review Checklists section.

Reviewer Instructions

Reviewers, please copy and paste a suitable review checklist into your review and answer all questions.

Appendix

This section should be the same for all PRs. Do not edit this section when creating a PR.

Review Checklists

Checklists maintained by the eLev lab for research repositories include:

Standard checklist

1. Are all files under 300 kB (if not, please carefully assess whether it is worth committing them)? **Yes or No**
2. Are all files named according to the appropriate [naming convention](https://github.com/Severson-Group/research-repo-template?tab=readme-ov-file#file-naming), i.e., dash-case, camelCase, snake case? **Yes or No**
3. Do all Markdown files follow the [CONTRIBUTING article template](https://github.com/Severson-Group/.github/blob/main/CONTRIBUTING.md#markdown-documentation-template)? **Yes or No**
4. Do all links work in the material that the PR is adding? **Yes or No**
5. Is the PR configured to close the correct issue(s)? **Yes or No**
6. Did the PR fully address the `Approach` section of the issue(s) it is closing? **Yes or No**

Please work on addressing any **No** items.

mhmokhtarabadi
mhmokhtarabadi previously approved these changes Jun 23, 2026

@mhmokhtarabadi mhmokhtarabadi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This PR looks good to me now. @noguchi-takahiro, could you review this PR?

  1. Are all files under 300 kB (if not, please carefully assess whether it is worth committing them)? Yes
  2. Are all files named according to the appropriate naming convention, i.e., dash-case, camelCase, snake case? Yes
  3. Do all Markdown files follow the CONTRIBUTING article template? No contributing articles
  4. Do all links work in the material that the PR is adding? Yes
  5. Is the PR configured to close the correct issue(s)? Yes
  6. Did the PR fully address the Approach section of the issue(s) it is closing? Yes

@noguchi-takahiro

Copy link
Copy Markdown
Contributor

Thank you @AwesomeTornado and @mhmokhtarabadi on making dark mode images.

@AwesomeTornado I have a one question here. When I make a rendered page looking like website, I usually do make html command. When I do this, it seems like all of version of 1.1 - 1.4 were compiled, but how can I find the current version in the feature/add-autogen-control-with-AMDC-article and render it?

@AwesomeTornado

Copy link
Copy Markdown
Member

@noguchi-takahiro Try running make clean and then make local

@noguchi-takahiro noguchi-takahiro left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thank you @Daehoon-Sung @mhmokhtarabadi @AwesomeTornado. Looks good to me.

This PR looks good to me now. @noguchi-takahiro, could you review this PR?

  1. Are all files under 300 kB (if not, please carefully assess whether it is worth committing them)? Yes
  2. Are all files named according to the appropriate naming convention, i.e., dash-case, camelCase, snake case? Yes
  3. Do all Markdown files follow the CONTRIBUTING article template? No contributing articles
  4. Do all links work in the material that the PR is adding? Yes
  5. Is the PR configured to close the correct issue(s)? Yes
  6. Did the PR fully address the Approach section of the issue(s) it is closing? Yes

@elsevers could you review this PR?

@elsevers elsevers left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Great, thanks @Daehoon-Sung and @noguchi-takahiro! This is getting close.

I have noted several feedback items inline below. A couple more things:

  1. Let's revise to use standard Mathworks terminology. The word "Autogen" is treated throughout both the article and tutorial as if that is a common, well known word. However, it is not --> for example, Google "matlab simulink autogen c code -- there is not a MATLAB page declaring "autogen" as a thing. I think it can be okay to use the term "Autogen," but it needs to be properly introduced.
  2. I like that we have links to various Mathworks supporting articles. However, we are missing a link (or a set of links) towards the start of the article to Mathworks explanation of autogenerating c code and their recommended best practices. We should tell readers that this article (and the tutorial) are our recommendation on how to translate those best practices to use in the AMDC environment.

Comment thread source/getting-started/control-with-amdc/autogen/index.md
Comment thread source/getting-started/control-with-amdc/autogen/index.md Outdated
Comment thread source/getting-started/control-with-amdc/autogen/index.md
Comment thread source/getting-started/control-with-amdc/autogen/index.md Outdated
Comment thread source/getting-started/control-with-amdc/autogen/index.md Outdated
Comment thread source/getting-started/control-with-amdc/autogen/index.md Outdated
Comment thread source/getting-started/tutorials/autogen/index.md Outdated
@noguchi-takahiro
noguchi-takahiro dismissed stale reviews from mhmokhtarabadi and themself via f2f53d5 August 23, 2026 20:36
@noguchi-takahiro

Copy link
Copy Markdown
Contributor

@elsevers I have addressed your feedback. Can you review this PR?

@noguchi-takahiro

Copy link
Copy Markdown
Contributor

@elsevers this PR is ready for you.

@elsevers elsevers left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks @noguchi-takahiro! I took a quick look and noted a couple more things -- listed inline below.

Comment thread source/getting-started/control-with-amdc/autogen/index.md Outdated
Comment thread source/getting-started/control-with-amdc/autogen/index.md Outdated
@noguchi-takahiro

Copy link
Copy Markdown
Contributor

@elsevers I addressed your feedback and this is ready for review again.

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.

Add AMDC article of Autogen in "Control with AMDC" section Add AMDC tutorial article using Simulink Autogen

5 participants