Skip to content

[Feature] Added VuePress for documentation#99

Open
errajswami wants to merge 6 commits intoZulko:masterfrom
errajswami:master
Open

[Feature] Added VuePress for documentation#99
errajswami wants to merge 6 commits intoZulko:masterfrom
errajswami:master

Conversation

@errajswami
Copy link
Copy Markdown

Did basic setup for documentation
https://errajswami.github.io/eagle.js/

There is a lot of scope for improvements, it is a just first step towards it.

  • Can create a workflow for automatically publishing document on merge.
  • Pages cab separated at its own page. Right now everything is at single page.

@errajswami
Copy link
Copy Markdown
Author

errajswami commented May 17, 2020

@Zulko Would you like to look at this?

@christian-nils
Copy link
Copy Markdown
Contributor

I personally like it very much. Hopefully @yaodingyd will accept the PR.

@Zulko
Copy link
Copy Markdown
Owner

Zulko commented May 22, 2020

Sorry for the delay. Thanks a lot for this that looks really good!! The one thing I am not sure I understand is the deploy.sh which, how is it used? Does it commit the built docs to master? Could you also update the repo url in that file?

@errajswami
Copy link
Copy Markdown
Author

https://vuepress.vuejs.org/guide/deploy.html
@Zulko Can you please have a look at this ^. We can discuss more if you want. (Sorry for delay)

@errajswami
Copy link
Copy Markdown
Author

@Zulko We can set on which branch we have to push the build. and the same branch we can use for Github pages.

Also, the current pull request does not include in workflow automation for deployment. We will have to work together for that.

@prashantswami
Copy link
Copy Markdown

@Zulko what is holding up to get this in?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants