Skip to content

Added document "Layout of the mruby filesystem" - #6434

Merged
matz merged 1 commit into
mruby:masterfrom
dearblue:doc/hier
Nov 27, 2024
Merged

Added document "Layout of the mruby filesystem"#6434
matz merged 1 commit into
mruby:masterfrom
dearblue:doc/hier

Conversation

@dearblue

Copy link
Copy Markdown
Contributor

This text was translated from Japanese to English by https://www.deepl.com/ .


@dearblue
dearblue requested a review from matz as a code owner November 24, 2024 12:41
@github-actions github-actions Bot added the doc label Nov 24, 2024
@dearblue

dearblue commented Nov 24, 2024

Copy link
Copy Markdown
Contributor Author

The original Japanese file is available on Gist.
https://gist.github.com/dearblue/d1ce7d87f52c1b5ffacbddf1633a24b7

I will add another document as another PR in due course.
https://gist.github.com/dearblue/6c059bd77fa73863e3d6dd10976a44a5

@dearblue
dearblue marked this pull request as draft November 24, 2024 12:53
@dearblue

Copy link
Copy Markdown
Contributor Author

😿 prettier complains about the need for a blank line after a comment...

@jbampton

Copy link
Copy Markdown
Contributor

😿 prettier complains about the need for a blank line after a comment...

You could add the README to .prettierignore

https://github.com/mruby/mruby/blob/master/.prettierignore

@dearblue

Copy link
Copy Markdown
Contributor Author

Thanks for your suggestion.
However, I think README.md should be under the influence of prittier.
So I will update the task.

@matz

matz commented Nov 25, 2024

Copy link
Copy Markdown
Member

"Layout of the mruby filesystem" sounds like a file system written for mruby. Probably "directory structure" is better.
However, I am not an English native.

@dearblue

Copy link
Copy Markdown
Contributor Author

Thanks for the review.
I have changed the wording.
And prettier also passed verification.

@dearblue
dearblue marked this pull request as ready for review November 26, 2024 12:42
Comment thread doc/guides/hier.md Outdated
@@ -0,0 +1,64 @@
<!-- summary: About the mruby directory structure -->

# Layout of the mruby directory structure

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.

Probably “The mruby directory structure” is better.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Changed.

Comment thread doc/guides/hier.md Outdated

# Layout of the mruby directory structure

A sketch of the mruby directory hierarchy.

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.

I am not a native, but we don't need this sentence altogether, IMO.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Deleted.

This text was translated from Japanese to English by https://www.deepl.com/ .
@matz
matz merged commit a5c6cb5 into mruby:master Nov 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants