Skip to content
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

[Feature] Added VuePress for documentation #99

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

errajswami
Copy link

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
Author

errajswami commented May 17, 2020

@Zulko Would you like to look at this?

@christian-nils
Copy link
Contributor

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

@Zulko
Copy link
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
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
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

@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