Skip to content

[Feature]: Display documentation for a given collection inside the bundle details view along with the details before installation #179

@gblanc-1a

Description

@gblanc-1a

Problem Statement

As a collection author I want to be able to publish documentation on how to use my collection.

Proposed Solution

  • Could be a md file to put inside the docs folder in a scaffolding so that we have documentation for each of the collection
  • The root README.md of the source repository should have a table of all collection in the repository with an index to their documentation
    • Readme might need to be published as part of the bundles when present
  • In addition today to get all the details about a bundle we wait until after installation to give them. We should give it directly in the marketplace as much details as possible
  • Be careful to remain backward compatible with previously released bundle but also other source types (awesome-copilot, skills)

Nice to have:

  • Search field in the marketplace should also search inside the README.md file.

Today after installation

Image

Today before installation

Image

Metadata

Metadata

Assignees

Type

No type

Projects

Status

In progress

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions