webstudio-is / webstudio

Open source website builder and Webflow alternative. Webstudio is an advanced visual builder that connects to any headless CMS, supports all CSS properties, and can be hosted anywhere, including with us.
https://webstudio.is
GNU Affero General Public License v3.0
5.34k stars 652 forks source link

Embedded education #4384

Open kof opened 1 week ago

kof commented 1 week ago

As a builder I want to learn about things without leaving the builder. We should be able to show as much as possible educational content directly in the builder.

For example tooltips could have a link that goes to mdn like here or they could have a button "learn more" and open a dialog directly in the builder that shows a video or documentation.

Maybe we could simply display the right documentation page in an iframe and focus on building a great documentation site, so we can reuse it for both.

johnsicili commented 1 week ago

I would rely on docs as much as possible so we have one source of truth. At most IMO we can add like one sentence of info to the builder like we already do in many places like tokens or local.

One thing to consider is links to sections on a page as they may change over time with copy edits and links will break. I try not to link too much to IDs, though it's still necessary from time to time.. just higher risk of those links breaking.

kof commented 1 week ago

If we rely on ids, then we need to ensure they are set explicitely and can't change by accident, not sure gitbook can do that