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 Docs: Improve custom widgets documentation #7032

Merged
merged 2 commits into from
Jan 15, 2024

Conversation

zoetrope69
Copy link
Contributor

@zoetrope69 zoetrope69 commented Jan 14, 2024

https://deploy-preview-7032--decap-www.netlify.app/docs/custom-widgets/

  1. Fix the code example
    The code example for the registerEditorComponent is incorrect as the line name: 'details', should be name: 'detail',. I think this mistake has come about because we're naming the field name the same as the HTML element <details>.
    I'm proposing to rename it to contents to avoid this mistake in the future.

  2. Markup headings correctly
    We're currently marking up what look like headings with a ** bold to make it look like a heading. I'm proposing we use actual headings here.

  3. Remove 'results' section
    It seems to be from some previous code example where it referred to a Youtube widget. This doesn't seem to be relevant anymore.

  4. Remove unnecessary links
    Looks like Gatsby create the anchor links automatically for each heading so we don't need to define them for the 'Development' and 'Production & Publishing' headings

    A beaver

Copy link

netlify bot commented Jan 14, 2024

Deploy Preview for decap-www ready!

Name Link
🔨 Latest commit 9387b6b
🔍 Latest deploy log https://app.netlify.com/sites/decap-www/deploys/65a3781cf5192e0008534a0e
😎 Deploy Preview https://deploy-preview-7032--decap-www.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@martinjagodic martinjagodic enabled auto-merge (squash) January 15, 2024 09:06
@martinjagodic martinjagodic merged commit 6ce52fb into decaporg:master Jan 15, 2024
18 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