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

Link doc entries to their definition in p5 source code. #1248

Merged
merged 1 commit into from Feb 11, 2016

Conversation

@toolness
Copy link
Member

toolness commented Feb 11, 2016

One of the hardest things about fixing a minor bug or typo is figuring out where it's located in a project's source code.

But one of the great things about YUIDoc is that it gives us that information in the data.json blob it builds for our reference docs!

So I thought that it might be nice to unintrusively link to the source code for a p5 API in its documentation. I stress the word unintrusively because I don't want to confuse the beginners who may be learning programming for the first time, and could be thrown off by the extra information.

Other benefits of linking to the source:

  • It invites users of p5 to become contributors.
  • It generally makes it easier to "pop open the hood" and see how p5 works.

Here's what it looks like--the example screenshot below is taken from the documentation for plane():

2016-02-11_8-58-28

The first link there is to view the source for plane(), while the second is to edit it (yay to GitHub for providing permalinks to edit files at a specific line number!). My hope is that beginners who don't know anything about git can fix simple typos and issue PRs for them.

Notes:

  • Um, I couldn't easily figure out where the CSS for the docs were stored, so I've inlined the CSS for now. It is kind of gross but I should be able to fix it before merging.
@iamjessklein
Copy link
Contributor

iamjessklein commented Feb 11, 2016

👍 I agree this feels like a super humane approach to redirects @toolness

@PaliwalSparsh
Copy link
Contributor

PaliwalSparsh commented Feb 11, 2016

This is simply amazing. 😃

@lmccart
Copy link
Member

lmccart commented Feb 11, 2016

brilliant, love it. we also have this addition to the footer. i'm going to go ahead and merge both and then you or i can take a crack on styling. the css files are actually located in the p5.js-website repo: https://github.com/processing/p5.js-website/blob/master/css/main.css

lmccart pushed a commit that referenced this pull request Feb 11, 2016
Link doc entries to their definition in p5 source code.
@lmccart lmccart merged commit 3c58b8b into processing:master Feb 11, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants
You can’t perform that action at this time.