search

herbsjs / herbsjs.github.io

Herbs website and docs
https://herbsjs.org/
Other
11 stars 40 forks source link

Implements fetch for readme file of glues #143

Open judibo opened 2 years ago

judibo commented 2 years ago

Implements fetch for readme file of glues to solve the problem on issue #111 and dynamic renders the readme file at the documentation page.

Here is a print to check how it´s being rendered at the doc locally x readme at github for the herbs2gql glue. image

I´m sending only 1 glue for now, so we can check how it will work on Production. If everything works fine, as it is running locally, I´ll implement on the other glues.

jhomarolo commented 2 years ago

It is under conflict

jhomarolo commented 2 years ago

It is under conflict

jhomarolo commented 2 years ago

Also, can you change all the glues?

judibo commented 2 years ago

Hi @jhomarolo, just updated with the other glues.

dalssoft commented 2 years ago

First, I wanted to say that this PR is very important for the future maintenance of the Herbs documentation. Thank you @judibo !

However, as it is today, we have a problem: we replaced the local docs with the readme.md files from the glue repositories. These readme.md files are not up to date, nor structured for the site's documentation (ex: header structure, links, etc). Therefore, accepting this PR as it is today would be a step backwards in the quality of the documentation presented. As a first step we should fix these files (readme.md files on each glue repo) to be able to accept this PR.

Ideally, we should update the repos with a structure that is not dependent on the readme.md file, like the structure suggested in issue https://github.com/herbsjs/herbsjs.github.io/issues/145.