How to make use of the "readme" field in the schema?

[schaetor]

Hello,

since we cannot reopen issue, for reference

How to make use of the "readme" field in the schema?
#188

The described approach seems not work.
For this component PartialDataRequestForm, I renamed the readme to check the described approach.

Starting with version 1.1.2 the readme file is named as the component, but does not appear in the dashboard
(Path /components/a2f8e592-5ec3-4d33-83b7-a79bacccb427/versions/589981d3-e27c-4926-96d0-f9e7b5121407/readme)
to 1.1.4
(Path /components/a2f8e592-5ec3-4d33-83b7-a79bacccb427/versions/09da0c67-eeaf-41a0-9418-7fb4a873a50d/readme)

Besides that, I observed that navigation within components is very slow, without visual feedback it does not feel that something is happening. It more stuck.

best Torsten

[lopesdasilva]

Can you please retest?

Looks ok here.

[schaetor]

Hi Rui,

I tried out on a existing component.
Are there some more steps to consider to do make it work, like certain dependency version to build with?

I documented my steps with a commit history to follow along.
https://github.com/vwdfive/marketplace/tree/test-en-readme

1. Changed the Readme filename to match the components name.
   https://stage.ethereal-nexus.org/components/b15dd72e-1b31-44b7-869e-0565b7d85903/versions/3d72d45f-f87b-4e23-95ea-2ce1c73f6e4b/readme
   Version 0.4.2

Result: Readme from schema is shown, not the contents of the readme file

2. Removed the readme property from the schema in the ethereal export wrapper
   https://stage.ethereal-nexus.org/components/b15dd72e-1b31-44b7-869e-0565b7d85903/versions/aa38d244-b5d6-4684-b72c-316fa46bf94a/readme
   Version 0.4.3

Result: No readme

Best Torsten

[schaetor]

Hi,

I got spoiled that the fix is using the whole file name and not the component name as described in the original issue.

... to use the Read me feature of the component you only need to add a .md file with the same name as the component. Each version can have its own read me file.

For example in our case, we have to keep the suffix *.ethereal also for the readme files.

It would be great to make this distinction clear in the docs for future users.