Skip to content

Conversation

@jjnawaaz
Copy link

Addresses #8442

Changes

  • Added documentation explaining the GLSL smoothstep(edge0, edge1, x) function
  • Included a short conceptual explanation of how smoothstep interpolates values
  • Documented its common usage for soft edges and anti-aliased stroke effects in the baseStrokeShader reference section

Screenshots of the change

Not applicable (documentation-only change).

PR Checklist

  • npm run lint passes
  • Inline reference is included / updated
  • Unit tests are included / updated

@welcome
Copy link

welcome bot commented Jan 25, 2026

🎉 Thanks for opening this pull request! For guidance on contributing, check out our contributor guidelines and other resources for contributors!
🤔 Please ensure that your PR links to an issue, which has been approved for work by a maintainer; otherwise, there might already be someone working on it, or still ongoing discussion about implementation. You are welcome to join the discussion in an Issue if you're not sure!
🌸 Once your PR is merged, be sure to add yourself to the list of contributors on the readme page !

Thank You!

@perminder-17 perminder-17 self-requested a review January 27, 2026 18:29
Copy link
Collaborator

@perminder-17 perminder-17 left a comment

Choose a reason for hiding this comment

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

Hi, thanks for your input on this, but I think you're targeting the wrong place to add docs for smoothStep. You need to place it here:

* @property {Object} combineColors
see how we have combineColors() you should add smoothStep in the same way. Feel free to reach out at discord if you have any questions. Anyways, thanks for your input on this.

@jjnawaaz
Copy link
Author

Hi,
Thanks for the pointer! I see that src/strands/p5.strands.js exists in commit 626996e, but it doesn’t look like it’s on main yet.
Should I:
Wait until this lands on main? or
Base my PR on the branch that includes this commit?

@jjnawaaz
Copy link
Author

Thanks for the review!
As per feedback, this documentation belongs in the p5.strands API rather than baseStrokeShader. I’ve opened a new PR targeting dev-2.0 with the docs added in src/strands/p5.strands.js.

Closing this PR in favor of the new one.

@jjnawaaz jjnawaaz closed this Jan 27, 2026
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