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

Embedded education #4384

Open
kof opened this issue Nov 7, 2024 · 2 comments
Open

Embedded education #4384

kof opened this issue Nov 7, 2024 · 2 comments
Assignees
Labels
complexity:medium Up to 1 week of work prio:1 The most important thing to work on type:feat Features and enhancements

Comments

@kof
Copy link
Member

kof commented Nov 7, 2024

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.

@kof kof added prio:1 The most important thing to work on type:feat Features and enhancements complexity:medium Up to 1 week of work labels Nov 7, 2024
@kof kof assigned kof and johnsicili and unassigned kof Nov 7, 2024
@johnsicili
Copy link
Contributor

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
Copy link
Member Author

kof commented Nov 7, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
complexity:medium Up to 1 week of work prio:1 The most important thing to work on type:feat Features and enhancements
Projects
None yet
Development

No branches or pull requests

2 participants