Suggestion to add a README.md to the READMEs folder #2935
+74
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
xguo-prestolabs
approved these changes
Nov 13, 2023
lws-team
force-pushed
the
main
branch
2 times, most recently
from
07b1c27 to
a99b954
Compare
Member
|
Thanks for the patch. Atm, gitohashi (on libwebsockets.org) and github don't agree on relative URL formats in their markup, so this can only work on one or the other (github as it stands), so it's waiting to modify gitohashi to work exactly the same. |
lws-team
force-pushed
the
main
branch
2 times, most recently
from
026710d to
9ba1504
Compare
lws-team
force-pushed
the
main
branch
4 times, most recently
from
fd918f2 to
207d634
Compare
lws-team
force-pushed
the
main
branch
9 times, most recently
from
a2a6fde to
7ae0640
Compare
lws-team
force-pushed
the
main
branch
5 times, most recently
from
a0c73c1 to
7c9d4bc
Compare
lws-team
force-pushed
the
main
branch
12 times, most recently
from
a800d4a to
7f2f518
Compare
lws-team
force-pushed
the
main
branch
3 times, most recently
from
baf4897 to
0c7fa23
Compare
lws-team
force-pushed
the
main
branch
3 times, most recently
from
2b74af4 to
5f77374
Compare
lws-team
force-pushed
the
main
branch
5 times, most recently
from
a677221 to
0c67054
Compare
lws-team
force-pushed
the
main
branch
2 times, most recently
from
f5fa440 to
278c671
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When new, it can take some time getting familiar with the libwebsocket repo, I found the readme files in the READMEs folder to be useful. The job of clicking on each file and then glossing over their content, takes some time and slows down finding what is useful at the moment for the developer.
I suggest adding a README.md file, using relative links as headlines to each file, and then pairing each entry with a little short paragraph abstract/summary to faster help devs get to the relevant Readme content for them.
I generated a file with all these relative links and added three summaries. There are some work needed for making all summaries, but that can be done over time by those who are most concerned. When done, I think it may be a helpful time saver. On GitHub as we all know the file named README.md in a folder, is automatically shown as the readme for that folder.