Skip to content

Standardize category description topic titles #559

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

Conversation

per1234
Copy link
Collaborator

@per1234 per1234 commented Dec 30, 2024

Each forum category contains a special topic which serves two purposes:

  • Define the description that is shown along with the category name in various parts of the forum UI
  • Document the purpose of the topic

The forum software gives these topics a title with the format "About the ___ category", and that has been adopted as the standard for Arduino Forum. Such standardization is important in order to allow the forum users to easily find the information about the purpose of each category so that they can determine whether it is appropriate for their topic.

Previously, the titles of some of these topics had been changed to have an "About the ___" format. In addition to being inconsistent, this also did not correctly reflect the true purpose of the topic.

Each forum category contains a special topic which serves two purposes:

- Define the description that is shown along with the category name in various parts of the forum UI
- Document the purpose of the topic

The forum software gives these topics a title with the format "About the ___ category", and that has been adopted as the
standard for Arduino Forum. Such standardization is important in order to allow the forum users to easily find the
information about the purpose of each category so that they can determine whether it is appropriate for their topic.

Previously, the titles of some of these topics had been changed to have an "About the ___" format. In addition to being
inconsistent, this also did not correctly reflect the true purpose of the topic.
@per1234 per1234 added type: imperfection Perceived defect in any part of project topic: code Related to content of the project itself labels Dec 30, 2024
@per1234 per1234 self-assigned this Dec 30, 2024
@per1234 per1234 merged commit 464ee65 into arduino:main Dec 30, 2024
13 checks passed
@per1234 per1234 deleted the standardize-category-description-topic-titles branch December 30, 2024 10:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: code Related to content of the project itself type: imperfection Perceived defect in any part of project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant