Add short descriptions to all sections #4519

Closed
opened 2025-11-26 21:04:12 -06:00 by GiteaMirror · 3 comments
Owner

Originally created by @nodiscc on GitHub (Apr 29, 2022).

Each section should have a description sentence that briefly describes what the section is about. Adding an inline link to a "canonical" resource on the subject (e.g. Wikipedia page) is recommended.

Examples:

In preparation of https://github.com/awesome-selfhosted/awesome-selfhosted/issues/1038, see https://github.com/awesome-selfhosted/awesome-selfhosted/milestone/2, https://github.com/awesome-selfhosted/awesome-selfhosted-data/pull/8

Originally created by @nodiscc on GitHub (Apr 29, 2022). Each section should have a description sentence that briefly describes what the section is about. Adding an inline link to a "canonical" resource on the subject (e.g. Wikipedia page) is recommended. Examples: - https://github.com/awesome-selfhosted/awesome-selfhosted/blob/master/README.md#communication---irc - https://github.com/awesome-selfhosted/awesome-selfhosted/blob/master/README.md#community-supported-agriculture-csa In preparation of https://github.com/awesome-selfhosted/awesome-selfhosted/issues/1038, see https://github.com/awesome-selfhosted/awesome-selfhosted/milestone/2, https://github.com/awesome-selfhosted/awesome-selfhosted-data/pull/8
GiteaMirror added the toolshelp wanted labels 2025-11-26 21:04:12 -06:00
Author
Owner

@FIDYOHARA777 commented on GitHub (Aug 2, 2022):

Each section should have a description sentence that briefly describes what the section is about. Adding an inline link to a "canonical" resource on the subject (e.g. Wikipedia page) is recommended.

Examples:

In preparation of https://github.com/awesome-selfhosted/awesome-selfhosted/issues/1038, see https://github.com/awesome-selfhosted/awesome-selfhosted/milestone/2, https://github.com/awesome-selfhosted/awesome-selfhosted-data/pull/8

Que porra é essa ?

@FIDYOHARA777 commented on GitHub (Aug 2, 2022): > Each section should have a description sentence that briefly describes what the section is about. Adding an inline link to a "canonical" resource on the subject (e.g. Wikipedia page) is recommended. > > Examples: > - https://github.com/awesome-selfhosted/awesome-selfhosted/blob/master/README.md#communication---irc > - https://github.com/awesome-selfhosted/awesome-selfhosted/blob/master/README.md#community-supported-agriculture-csa > > In preparation of https://github.com/awesome-selfhosted/awesome-selfhosted/issues/1038, see https://github.com/awesome-selfhosted/awesome-selfhosted/milestone/2, https://github.com/awesome-selfhosted/awesome-selfhosted-data/pull/8 Que porra é essa ?
Author
Owner

@nodiscc commented on GitHub (Aug 10, 2022):

After https://github.com/awesome-selfhosted/awesome-selfhosted/pull/3215, only Gateways and Terminal Sharing is missing a description (but needs reordering/cleanup).

awesome-selfhosted-data (master *%>)$ make awesome_lint 
...
WARNING:awesome_lint.py: Gateways and Terminal Sharing: description is empty
@nodiscc commented on GitHub (Aug 10, 2022): After https://github.com/awesome-selfhosted/awesome-selfhosted/pull/3215, only `Gateways and Terminal Sharing` is missing a description (but needs reordering/cleanup). ``` awesome-selfhosted-data (master *%>)$ make awesome_lint ... WARNING:awesome_lint.py: Gateways and Terminal Sharing: description is empty ```
Author
Owner

@Ki-er commented on GitHub (Aug 11, 2022):

With the merge of #3221, I believe this could be closed!

@Ki-er commented on GitHub (Aug 11, 2022): With the merge of #3221, I believe this could be closed!
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/awesome-selfhosted#4519