Skip to content
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

Suggestion to add a README.md to the READMEs folder #2935

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

VictorieeMan
Copy link
Contributor

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.

@VictorieeMan VictorieeMan marked this pull request as ready for review July 20, 2023 09:00
@lws-team
Copy link
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants