Skip to content

Reusing repo README for marketplace is restrictive; add an option #10485

Closed

Description

@DanTup

Apologies if this is the wrong place for this...

The docs for the manifest file state:

Have a README.md Markdown file in your extension's root folder and we will include the contents in the body of the extension details (on the Marketplace).

I recently got some comments that the Readme for my extension on GitHub is not very good to tell people what the project. I could add this to the top of the README, but it's redundant on the marketplace (as is installation instructions, which currently appear twice because I have them in my readme).

It would be great to have the option of using a different file than the same readme that GitHub will show on a repo page. That way, the GitHub-displayed README.md could explain what the project is and how to install it, whereas the marketplace-displayed file could omit this stuff (people on the marketplace or inside Code already know it's an extension and how to install it).

Activity

  1. joaomoreno commented on Apr 26, 2017

    @joaomoreno
    Contributor

    Won't fix any time soon. Sorry.

  2. locked and limited conversation to collaborators on Nov 18, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

feature-requestRequest for new features or functionality

Type

No type

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions