Skip to content

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

Open
Daehoon-Sung wants to merge 122 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 122 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.

@noguchi-takahiro

Copy link
Copy Markdown
Contributor

Hello @elsevers, I have addressed the item 1 in this comment. See the following rendered articles:

I also updated the index so that those contents show up on the left banner.

@Daehoon-Sung regarding the following comment, can you take a few minutes to review this discussion and make sure if we addressed all of these within the autogen article?

Take a look at the top two discussions here: https://github.com/Severson-Group/AMDC-Examples/discussions . Do we need to update out article to factor any of this in?

My takeaway is we already addressed these but I wanted to double check this with you.

@mhmokhtarabadi mhmokhtarabadi left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Thank you @Daehoon-Sung and @noguchi-takahiro for this nice article. I have some inline comments. Feel free to comment on what you think if you don't like my suggestions.

Comment thread source/getting-started/tutorials/autogen/index.md Outdated
Comment thread source/getting-started/tutorials/autogen/index.md Outdated
Comment thread source/getting-started/tutorials/autogen/index.md Outdated
Comment thread source/getting-started/tutorials/autogen/index.md
Comment thread source/getting-started/tutorials/autogen/index.md
@noguchi-takahiro

Copy link
Copy Markdown
Contributor

Thank you @mhmokhtarabadi. I addressed your feedback. Can you kindly update naming convention based on this latest article here or https://github.com/Severson-Group/KnowledgeBase/pull/366?

@elsevers elsevers requested a review from AwesomeTornado June 9, 2026 12:44

@AwesomeTornado AwesomeTornado left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Please make sure images are viewable in dark mode. See #177 and #173 for more info.

Graphics with white backgrounds that are already readable in dark mode don't need to be changed.

@noguchi-takahiro

noguchi-takahiro commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Thank you @AwesomeTornado. I checked the issue/PR you mentioned. I have a question:

Regarding the second item, I wonder how we can easily create the dark mode version of graphics? Do you use Inkscape or something coding?

image

@AwesomeTornado

Copy link
Copy Markdown
Member

I wonder how we can easily create the dark mode version of graphics? Do you use Inkscape or something coding?

@noguchi-takahiro I use Inkscape. First, press CTRL + SHIFT + D to open document settings. The Page, Border, and Desk options control what the default background color is. By changing these to be very dark, you can simulate what dark mode users will see.
image

To fix graphics, click on elements that are difficult to see, then use the properties panel on the right to increase the lightness of the fill, the outline, or both.

image

Once the image is readable, click Save As and append -dark to the filename.

@mhmokhtarabadi mhmokhtarabadi left a comment

Copy link
Copy Markdown

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

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