canonical / vanilla-framework

From community websites to web applications, this CSS framework will help you achieve a consistent look and feel.
https://vanillaframework.io
GNU Lesser General Public License v3.0
819 stars 167 forks source link

Create editable fields within code snippets #4337

Open danielmutis opened 2 years ago

danielmutis commented 2 years ago

After speaking with Landscape's product manager, he suggested we implement an editable field feature within the code snippet; which could update other pieces of code where the user's input may be needed. An example would be a tutorial where all the steps depend on a project's name, and they could replace that word in all following steps of the tutorial.

There is an example of this being implemented in google's documentation

Screenshot 2022-02-22 at 18.01.30.png

Screenshot 2022-02-22 at 18.01.39.png

Screenshot 2022-02-22 at 18.01.48.png

danielmutis commented 2 years ago

I think this feature would be very useful on other places, such as the Snapcraft yaml file on the first snap flow.

clagom commented 2 years ago

WG: @danielmutis to bring this up with the documentation team to double-check on the use-case

clagom commented 2 years ago

WG: @danielmutis please add it to your slides to discuss it with the documentation team

danielmutis commented 2 years ago

That's a good idea, I will add it!

clagom commented 2 years ago

WG: best to investigate the implementation challenge before spending time on designing the feature. Implementing this in Discourse might require a lot of JS, if even possible.