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

docs: extend mesh plugin introductions docs #6458

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

vronifuchsberger
Copy link

@vronifuchsberger vronifuchsberger commented Jan 12, 2024

Description

I discovered some gaps in the documentation when writing my own custom mesh plugin - now trying to contribute to the docs in hope to help the next person :-)

This is adding a few points to the plugin introduction docs; points covered are:

  • consuming a plugin that is in same codebase and not a individually published package
  • linking to envelop plugin lifecycle to show more clearly which other hooks are available
  • explain how to update context from within a plugin hook

Type of change

Please delete options that are not relevant.

  • documentation update

Screenshots/Sandbox (if appropriate/relevant):

N/A

How Has This Been Tested?

N/A

Checklist:

  • I have followed the
    CONTRIBUTING doc and the
    style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas - N/A
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works, and I have added a
    changeset using yarn changeset that bumps the version - N/A
  • New and existing unit tests and linter rules pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Further comments

If this is a relatively large or complex change, kick off the discussion by explaining why you chose
the solution you did and what alternatives you considered, etc...

Copy link

codesandbox bot commented Jan 12, 2024

Review or Edit in CodeSandbox

Open the branch in Web EditorVS CodeInsiders

Open Preview

@vronifuchsberger vronifuchsberger changed the title extend mesh plugin introductions docs docs: extend mesh plugin introductions docs Jan 12, 2024
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.

None yet

1 participant