Skip to content

Various clean-up and fixes of markdown linting issues #15

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.

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

Merged
merged 13 commits into from
Jun 9, 2025

Conversation

alexisrolland
Copy link
Contributor

@alexisrolland alexisrolland commented Jun 7, 2025

  • Added a shell script to automatically fix markdown linting issues. Updated README accordingly.
  • Standardized inputs and outputs titles (see table below).
  • Updated documentation for Note node.
  • Added documentation for MarkdownNote.
  • Standardized column header in inputs and outputs tables (to some degree, there's probably more to do).
  • Various other fixes.
Locale File Inputs Title Outputs Title
en.md Inputs Outputs
es.md Entradas Salidas
fr.md Entrées Sorties
ja.md 入力 出力
ko.md 입력 출력
zh.md 输入 输出

@benceruleanlu benceruleanlu self-requested a review June 8, 2025 06:20
@comfyui-wiki
Copy link
Contributor

@benceruleanlu Can this PR be merged? Saw you self-requested to be a reviewer. Currently I'm fine with it. But it does update tons of files, and I can't review all of them.

@alexisrolland
Copy link
Contributor Author

alexisrolland commented Jun 9, 2025

@benceruleanlu Can this PR be merged? Saw you self-requested to be a reviewer. Currently I'm fine with it. But it does update tons of files, and I can't review all of them.

Maybe I can elaborate a little bit on the changes I have done:

Inputs and Outputs Titles

I noticed the titles of inputs and outputs were inconsistent across nodes. They contained variety of values such as:

  • Input Parameters, Input Types, CLIPTextEncodeSDXLRefiner Input types, etc.
  • Output Results, Output Types, CLIPTextEncodeSDXLRefiner Output types, etc.

So the main changes here consist in standardizing these titles into two simple titles Inputs and Outputs. Moving forward I replicated this into other languages (except ru.md which did not have a locale for all the nodes), doing a lot of string replacements. If other languages are machine translated from en.md, I think the files can be replaced in the future to overwrite my changes.

Linting

The markdown wasn't properly formatted. Easy stuff to fix was adding blank lines before / after titles, bullet points, at the end of the files, etc. This was done using the markdownlint library.

Others

  • Tables headers are still very much inconsistent. I've fixed a few but there's more to do.
  • Some content in the tables are inconsistently formatted, typically some parameter names are formated with backticks and some are not. I've fixed a few but there's more to do.

Copy link
Collaborator

@benceruleanlu benceruleanlu left a comment

Choose a reason for hiding this comment

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

sorry for the delay 💤

quick question, is the ImageToMask copy folder supposed to exist?

also, feel free to open a feature request to make a bash equivalent of the .ps1 script, or just add that in this pr

overall great stuff--really appreciate the help 🌜

@benceruleanlu
Copy link
Collaborator

having a gh workflow to run markdownlint on PRs would be awesome as well, but that can be in a separate PR/issue

looks good to go as is

@alexisrolland
Copy link
Contributor Author

quick question, is the ImageToMask copy folder supposed to exist?

Oops, good catch! It's not supposed to be there. I'll clean it up.

also, feel free to open a feature request to make a bash equivalent of the .ps1 script, or just add that in this pr

I'll add it to that PR

@alexisrolland
Copy link
Contributor Author

@benceruleanlu tested the bash script and it works. This is ready to be merged.

@benceruleanlu benceruleanlu merged commit 4a9da27 into Comfy-Org:main Jun 9, 2025
2 checks passed
@alexisrolland alexisrolland deleted the alexis-updates branch June 9, 2025 06:11
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.

3 participants