Skip to content
New issue

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

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

Already on GitHub? # to your account

Add post asset source comments to "Moderator Instructions" post #489

Merged
merged 1 commit into from
Dec 18, 2024

Conversation

per1234
Copy link
Collaborator

@per1234 per1234 commented Dec 18, 2024

The "Moderator Instructions" post is illustrated with several graphics and diagrams.

The image files of the published post are hosted on the forum server, and so it is those URLs that are referenced in the image embedding markup. However, the source files for those assets are hosted in the arduino/forum-assets GitHub repository, and it is these files that should be worked with for any updates of the post.

Previously there was no indication in the post content of the source of its assets, and thus a contributor might not be aware or their existence, or where to find them. This is resolved by adding adjacent comments to the post content with links to the location of each of the asset source files.

The "Moderator Instructions" post is illustrated with several graphics and diagrams.

The image files of the published post are hosted on the forum server, and so it is those URLs that are referenced in the
image embedding markup. However, the source files for those assets are hosted in the arduino/forum-assets GitHub
repository, and it is these files that should be worked with for any updates of the post.

Previously there was no indication in the post content of the source of its assets, and thus a contributor might not be
aware or their existence, or where to find them. This is resolved by adding adjacent comments to the post content with
links to the location of each of the asset source files.
@per1234 per1234 added type: enhancement Proposed improvement topic: documentation Related to documentation for the project labels Dec 18, 2024
@per1234 per1234 self-assigned this Dec 18, 2024
@per1234 per1234 merged commit 90ca1ab into arduino:main Dec 18, 2024
15 checks passed
@per1234 per1234 deleted the source-comments branch December 18, 2024 03:32
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
topic: documentation Related to documentation for the project type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant