question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. ItĀ collects links to all the places you might be looking at while hunting down a tough bug.

And, if youā€™re still stuck at the end, weā€™re happy to hop on a call to see how we can help out.

Prompt users to open Readme on developer's request

See original GitHub issue

šŸ“ Provide a description of the new feature

There are currently themes and extensions that has this issue (eg. Dribbblish Dynamic) where the users are required to install the theme/extension locally or to take extra steps before installing, and that Marketplace installation doesnā€™t work properly for them.

In order for theme/extension developers to not feel discouraged from publishing to Marketplace, Iā€™d suggest making an additional field on the manifest format that requests Marketplace to open its Readme and read the requirements before installing (boolean value).

āž• Additional Information

Currently I can think of a few ways to do this:

  • For the specified theme/extension, replace the Install button on Cards to the GitHub icon, on click it would prompt the user with a modal which would open the Readme externally (on their browser etc.).

This means that users will have to install said theme/extension via the CLI.

  • We could also use the GitHub icon but open the Readme inside Marketplace itself, with a notification shown that tells the user to read the Readme beforehand and then they can install the theme/extension using the button inside the Readme page.

This means that users can still install said theme/extension via Marketplace, and the extension/theme devs can include whether it should be installed Marketplace or not.

Issue Analytics

  • State:open
  • Created a year ago
  • Comments:5 (5 by maintainers)

github_iconTop GitHub Comments

1reaction
theRealPadstercommented, Oct 8, 2022

Ah, right, didnā€™t think of that. I think itā€™s probably easier to support just having it open externally and make them install via cli. Otherwise youā€™ll have people with weird hybrids

0reactions
kyrie25commented, Oct 8, 2022

What doesnā€™t work when installed via marketplace? Themes have the ā€œincludeā€ array to bundle extensions in them.

Stuff like Dribs, Dribs Dynamic & Default not working properly since it requires libraries to be loaded early or requires extra patching in config-xpui, etc. Would be nice for extensions that wants to use custom hooks also. image

Read more comments on GitHub >

github_iconTop Results From Across the Web

User Data Options - ReadMe Documentation
If a user is not logged in, and OAuth Login is set up, there will be a prompt on the default variable for...
Read more >
Feature Request: Automatically Open readme.md Files #10353
My scenario is wanting to make documentation obvious to users of company-internal packages that have various (and usually somewhat low) levelsĀ ...
Read more >
How to Write a Good README File for Your GitHub Project
Provide a step-by-step description of how to get the development environment set and running. 5. How to Use the Project. Provide instructionsĀ ...
Read more >
Should my application's README be for developers or users
Who you are means nothing: open the readme first. From there you should direct users to the proper documentation:.
Read more >
writemereadme - npm
A console application to streamline creating readme files for developers. Upon running WritemeREADME, the user is presented with a series ofĀ ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found