weDevsOfficial / wedocs-plugin

A documentation plugin for WordPress
https://wordpress.org/plugins/wedocs/
GNU General Public License v2.0
195 stars 93 forks source link

Creating a Gutenberg WeDocs block. #113

Open paaljoachim opened 3 years ago

paaljoachim commented 3 years ago

Hey

I am testing the WeDocs plugin and really like what I see. These days I am using it to create an example support and documentation dev site for WordPress suggesting new ideas on how to better structure and present documentation.

There are a few things I would like to see and hope that this is possible for you to do.

In Gutenberg there is now under development a Gallery block using nested/inner/child Image blocks. Gallery as a parent has its own sidebar settings, and the Image blocks have its own sidebar settings. Here is the PR: https://github.com/WordPress/gutenberg/pull/25940

Bottom line is that having a parent block with its own settings and child blocks that have their own settings can really create some nice customizations. Other examples of parent <-> nesting are:

From post I made at the Facebook Advanced WordPress group: https://www.facebook.com/groups/advancedwp/permalink/3715274528534734/

Nesting/inner blocks will transform how we interact with Gutenberg blocks.

Check out these PRs:

Quote: convert to nested blocks https://github.com/WordPress/gutenberg/pull/25892

Not yet a PR. Just waiting for a developer to pick it up. List Block: Try nesting with InnerBlocks https://github.com/WordPress/gutenberg/issues/6394

Edit: Here is another Nesting issue I came across earlier today. Table Block: Should we use InnerBlocks? https://github.com/WordPress/gutenberg/issues/18768

There are so many possibilities with nesting/inner blocks. It gives us a huge potential in adjusting how we want the contents of the block to become.

sekanderb commented 3 years ago

+1 for gutenberg blocks to show latest documentation and design a documentation landing page

saiftheboss7 commented 1 year ago

@sekanderb @paaljoachim If you don't mind me asking, what are the most critical customization options that you need from the Gutenberg block of weDocs?

sekanderb commented 1 year ago

Hey @saiftheboss7, Thank you for following up. When I tested weDocs with an FSE theme, the template was not working. The breadcrumb and sidebars with links were not displaying correctly. Try installing the plugin with Ollie or Spectra One, and you will see the problems.

As Gutenberg now has post loop and other display features, testing those and mentioning their support would be nice. In this way, people can design the documentation home page with a more personalized design.

PS: BetterDocs just released their FSE compatibility yesterday 😉 I gave them 5 stars today.

paaljoachim commented 1 year ago

I have not tested WeDocs in quite a while. I assume it is better now then when I initially made this issue....

anik-fahmid commented 1 year ago

@paaljoachim We just released a completely revamped version. You should try it.