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

Update WebGL contributor docs #6625

Merged
merged 1 commit into from
Dec 13, 2023

Conversation

davepagurek
Copy link
Contributor

@davepagurek davepagurek commented Dec 12, 2023

This brings some initial changes from our STF documentation work into the repo.

It includes two Google Docs converted to markdown via https://davepagurek.github.io/google-docs-to-markdown/. After passing it through the converter, I had to do a bit extra manual work:

  • I converted Markdown images to the <image> tag to manually specify a width to make the SVGs more readable
  • I updated image URLs to be relative paths to the assets folder
  • I manually added js as the language to the code fence blocks

Here's a link to one file directly, so you can see how it looks when reading it on Github: https://github.com/davepagurek/p5.js/blob/0d19d92ee46e5ae2a3568354106e8fc0b6101fc9/contributor_docs/webgl_mode_architecture.md

PR Checklist

  • npm run lint passes
  • [Inline documentation] is included / updated
  • [Unit tests] are included / updated


## Resources

- Read our [p5.js WebGL architecture overview](webgl_mode_architecture.md) to understand how WebGL mode differs from 2D mode. This will be a valuable reference for some implementation specifics for shaders, strokes, and more.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@limzykenneth This doc links to the other doc. Right now I have this linking to an md file with a relative path, but I'm not sure if that will get converted when put onto p5js.org. Should we just do this and add link conversion to the requirements when parsing md(x) files for the site?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah let's leave it as is for now if the link is currently working. We'll review if we need to change it when the website has more structure.

@limzykenneth limzykenneth merged commit fb70e98 into processing:main Dec 13, 2023
2 checks passed
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.

2 participants