-
Notifications
You must be signed in to change notification settings - Fork 40
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Implements fetch for readme file of glues #143
base: master
Are you sure you want to change the base?
Conversation
It is under conflict |
This reverts commit 4afb5ea.
docs/glues/herbs2gql.md
Outdated
|
||
<ReadMeDoc docURL='https://raw.githubusercontent.com/herbsjs/herbs2gql/master/README.md'/> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this should be inside a env file
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wasn´t able to put it inside the md file, but I put the base URL inside the env file to import it at the react component and oly pass the endpoint at the md file.
src/components/ReadMeDoc.js
Outdated
|
||
return ( | ||
<> | ||
<ReactMarkdown children={markdown} /> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What happens if url is unavailable or broken?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point!
Just implemented a catch with an Error message, asking to go to github doc instead.
It is under conflict |
Also, can you change all the glues? |
Hi @jhomarolo, |
sidebar_label: Error to Text | ||
slug: /glues/suma2text | ||
hide_title: true |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why not create an .md
generator? we could have all this information inside 1 file in json format, so the generator generates everything before deploying
Another suggestion is, why not read all repositories so auto-creates these files? it looks simple as all files have a similar structure
}, []) | ||
|
||
return ( | ||
<> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this indentation is correct? It looks so long
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 Ideally, we should update the repos with a structure that is not dependent on the |
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.
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.