Want to contribute in carbon's documentation under GSoC'23.

[H9660]

Hi internet!

This is Hussain Lohawala, a penultimate year student in Chandigarh University. I am currently studying computer science.
After browsing the list of the project ideas, I had my interest laid down on the project Creating documentation for Carbon source files.

The project details are:

Difficulty level: ____
Skills required/preferred: C++, HTML, MarkDown, language parsing
Project size: 350 hr

Generate documentation from Carbon source files. This might include:

• Producing HTML and/or MarkDown output
• Converting declarations for classes, functions, interfaces, and so on.
• Extracting marked comments
• Recognizing commenting conventions for parameters, returns, cross reference, markdown code snippets, and so on.
• Cross referencing declarations, definitions, and possibly uses
• Continuous integration for deployment

Why me?

• I am quite familiar with the concepts of git that are used heavily in various open source projects.
• I have been accepted as a contributor in Hackoctoberfest twice in 2022 and 2023.
• I am really good at editing text with markdown.
• I have made some really cool projects in HTML, CSS and javascript and am really good at writing documention and explaining my work.
• In my previous semester I had covered subjects like Systems Programming in which I thoroughly studied langauge parsing in langauge processing.
• I practice problem solving daily at Leetcode and have maintained a streak of 94 days.

Here are some of my work:

• Estates: estatery-nine.vercel.app
• Wordle: wordlev1.vercel.app
• Cheer's Cafe: cheer-cafe.vercel.app

My commitments

I commit the following as a contributor in Carbon:

• I commit to devote my full time in this project as I don't have any holiday plans during this summer.
• I commit to keep any confidential information about carbon secretive and not revealing it to third parties.
• I commit to produce work that is original free from any plagiarism.
• I commit to be active in this project and not miss any deadlines be if for milestones or any other evaluation.
• I commit to keep on contributing to this repository even after I had completed this project with Carbon.
• I commit to be in contact with the mentors throught the GSoC official period.

Regards

[H9660]

I want your guidance in the same, @jonmeow.

[H9660]

Here is my proposal.
Doc_generation_proposal_for_gsoc.docx

Please review it @jonmeow

[jonmeow]

Please note that per GSoC's timelines, applications are not currently being accepted. When applications open up on March 20, I think you'll need to apply through GSoC's website (here's Carbon's page). You might also want to read Carbon's contributor guidance. Applications here won't be included.

[chandlerc]

BTW how many projects are expected to be selected by Carbon this time?

There is a maximum number of spots, and I'm not sure exactly what it is or if it is still subject to change, but its a very small number. I think if we have good applications (especially, ones we have reasonably high confidence will be successful at their project), we'll try to accept the maximum number, but again, that's going to be very small. We're also still a pretty small community and so don't have a lot of mentors available. =]

[H9660]

Thanks for the information. I could'nt find the discord server associated with carbon. Can you help me out?

[KateGregory]

If you go to https://github.com/carbon-language/carbon-lang (the main page) and scroll right down to the bottom, you'll find the Join Us section which includes the Discord link along with other things you should read such as the code of conduct.

[H9660]

Ok sir. Thanks a lot.

[jonmeow]

@H9660 "sir" is a formal way to address a man, but not typically appropriate for addressing a woman. Please bear in mind that we have both women and men in our community, and avoid using gendered terminology when you don't know the right choice.

[H9660]

Alright I'll keep that in mind. Sent from Outlook for Android<https://aka.ms/AAb9ysg>

…

________________________________ From: Jon Ross-Perkins ***@***.***> Sent: Monday, March 20, 2023 11:17:40 PM To: carbon-language/carbon-lang ***@***.***> Cc: Hussain Lohawala ***@***.***>; Mention ***@***.***> Subject: Re: [carbon-language/carbon-lang] Want to contribute in carbon's documentation under GSoC'23. (Discussion #2676) @H9660<https://github.com/H9660> "sir" is a formal way to address a man, but not typically appropriate for addressing a woman. Please bear in mind that we have women in our community too. — Reply to this email directly, view it on GitHub<#2676 (reply in thread)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/ARPV7GRGKKSZOIJLH75QPN3W5CJ3ZANCNFSM6AAAAAAVYT576U>. You are receiving this because you were mentioned.Message ID: ***@***.***>