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 basic documentation #215

Closed
cengizIO opened this issue Mar 2, 2016 · 2 comments
Closed

Add basic documentation #215

cengizIO opened this issue Mar 2, 2016 · 2 comments

Comments

@cengizIO
Copy link

@cengizIO cengizIO commented Mar 2, 2016

Hello!

I'm extremely interested in learning rust and I just started exploring servo engine. I'd be very happy if I can contribute to webrender, servo or rust in general.

As a newcomer, I'm having difficulties due to lack of basic documentation like instructions, requirements, assumptions or guides.

So, I think we should put some documentation into the repository.

Any suggestions?

@KiChjang
Copy link
Member

@KiChjang KiChjang commented Mar 2, 2016

@cengizIO If you're starting out on Rust and want to contribute to something easy, head over to http://servo.github.io/servo-starters to pick something that you'd like to work on. If you're talking specifically about webrender, the GitHub wiki page should have an overview of how WR works.

But I agree that WR should have more documentation. https://doc.servo.org/webrender is lacking quite a bit of documentation.

@glennw
Copy link
Member

@glennw glennw commented Aug 28, 2016

Some basic API documentation got added here #317

@glennw glennw closed this Aug 28, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
You can’t perform that action at this time.