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

Add Readme Parsing #5

Open
William-McGonagle opened this issue Jan 23, 2023 · 2 comments
Open

Add Readme Parsing #5

William-McGonagle opened this issue Jan 23, 2023 · 2 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@William-McGonagle
Copy link
Member

One of the important features that will make developer's lives simpler is reading through their readme files and picking out the important information. For instance, if they have a section of the readme titled 'About', then we can use that information for the about page.

If you would like to take this issue, leave a comment below.

@William-McGonagle William-McGonagle added enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed labels Jan 23, 2023
@Rishav1707
Copy link

This means we have to add a subsection in README i.e About section for the description of the project.

@William-McGonagle
Copy link
Member Author

Hi @Rishav1707

Not exactly. The Donovan tool pretty much can scan any GitHub repository and generate a documentation website for it. To make the tool even better, we need to start scanning the GitHub repository Readmes. If we look through a repository's readme, we can usually find information about what their repository is for, who maintains it, etc. And, we can make the generated website better tailored to the GitHub repository its based on.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants