search

manrajgrover / algorithms-js

Consumable Data Structures and Algorithms library in JavaScript
MIT License
198 stars 129 forks source link

Improve documentation interface #23

Open manrajgrover opened 6 years ago

manrajgrover commented 6 years ago

Better interface is needed (this could be some other documentation generation tool, if required)

gaurav-nelson commented 5 years ago

@manrajgrover Are you still keen on this issue. I can help you by setting up documentation on GitHub pages using Slate. algorithms-js better suits for this rather than docasauras (which is a beast to maintain). Let me know. 🥂

manrajgrover commented 5 years ago

@gaurav-nelson Yes, please. I'm open to any tool which serves the purpose. Are you interested in taking this one up?

gaurav-nelson commented 5 years ago

@manrajgrover sure, I will try to put something up after the weekend and we can take it from there.

manrajgrover commented 5 years ago

@gaurav-nelson Sounds great! Looking forward to it.

gaurav-nelson commented 5 years ago

@manrajgrover To get started, please do the following:

  1. Fork the Slate repo (https://github.com/lord/slate)
  2. Rename the forked slate repo to algorithms-js-docs
  3. Give contributor rights to this repo to me (so that I can easily modify content without creating PR's)

Once you will set this up, I will go ahead and update the documentation. Once done, we can review (and modify) the docs as needed and then deploy the docs to manrajgrover/algorithms-js in gh-pages branch. Later we can then setup Travis job to push updates on every merge in our docs repo.

manrajgrover commented 5 years ago

@gaurav-nelson Thanks for sharing the process. How do you plan to deploy in this project after building documentation in a separate fork?

gaurav-nelson commented 5 years ago

@manrajgrover Slate has a script called deploy.sh To deploy to another repo we will add this original repo as a remote to the docs repo, then we can specify the remote in the script. The script then handles creating and pushing updates to the gh-pages branch. Someone (you) who have permissions to both the repos can run deploy.sh to publish first version and later we can setup a Travis job to handle this automatically.

PS:https://spectrum.chat/thread/02ff52c3-ac64-49b0-bcae-d32e7ef337ce?m=MTUyNzU0MDgyNDkxNA==

I have tested this and it is working for me.

manrajgrover commented 5 years ago

@gaurav-nelson Sounds great then. I already had a fork of slate project and have added you as a collaborator. Feel free to ping me if you face any issue