docs: Added "Edit this page" link #3782
Conversation
|
That looks amazing! Thanks for the PR |
toschdev
changed the title
toschdev
changed the title
|
When trying to test this I somehow get this error. Has this been working for you when you tested? |
|
It looks like there was an error because your fork was out of sync, i will investigate more For users that don't have a fork out of sync it works, i tested with #3787 |
|
I've just used the link you provided and tried to test with your fork, indeed. I think should be worth a try |
|
I just deployed a fix for fork syncing, it should work now, try this link: https://holocron.so/github/pr/ignite/cli/main/editor |
| @@ -51,6 +51,9 @@ const config = { | |||
| }, | |||
| sidebarPath: require.resolve("./sidebars.js"), | |||
| routeBasePath: "/", | |||
| editUrl: ({ docPath }) => { | |||
| return `https://holocron.so/github/pr/ignite/cli/main/editor/docs/docs/${docPath}` | |||
There was a problem hiding this comment.
Why is it using a third-party link? I'd rather point to the GitHub editor directly. On save it, as well, asks if you want to fork and create a new branch. This removes the reliance on a third-party service.
https://github.com/ignite/cli/edit/main/docs/docs/${docPath} should work I believe (and if it does not it would have if we used an ordering in the docs using category.json instead of xx-path I guess).
There was a problem hiding this comment.
With Holocron you have a WYSIWYG editor, easier to use for non technical people
it also has real time collaboration and you can edit users PRs code with one click instead of checking out on their fork
There was a problem hiding this comment.
Why would non technical people read the Ignite CLI docs? For building a blockchain you need to be technical imho. Additionally, we are talking about markdown here, which does not have the most complicated syntax.
The flow now for editing a page is to grant access a third party tool to your GitHub account, while GitHub just provides an editor, and you are able to easily render it from there as well.
There was a problem hiding this comment.
Feel free to close this PR, I personally prefer writing in a WYSIWYG editor
There was a problem hiding this comment.
Ok, please let us know if you'd like to continue on this in the future, this could have been a good addition but we can not depend on an online service.
With this PR readers can suggest changes to the docs with an easy to use WYSIWYG markdown editor.
This is how the editor looks like for this repo.
holocron-docusaurus-demo.mp4