operationcode_frontend
operationcode_frontend copied to clipboard
serve documentation files using docsify
Description of changes
Use Docsify to serve front-end documentation files
Issue Resolved
Fixes #518
Hey Tal, in the interest of time, how should one go about testing this?
Once the the build is complete you can simply type docsify serve docs
in the terminal and go to localhost:3000 to view the readme or localhost:3000/#/CONTRIBUTING to view the contributing file.
I'm not really sure how are we going to integrate it with the website though.
Hey Tal, did you add docsify as a dev dependency? I am getting an error that docsify doesn't exist.
How do I do that? I added it to the package.json file
yarn add docsify --dev
or npm install docsify --dev
@Cooperbuilt @tal87 it was added as a dependency, but the yarn.lock
file was not added. Running yarn install
when inspecting this branch should fix the issue. If it's supposed to be a DEV dependency, then the edit to package.json
will need to moved accordingly.
Unsuccessful for me with yarn install
, tested that as well
I ran yarn install
and now I see docsify in the yarn.lock
file.
Should I just commit it?
@tal87 please.
Done!
I'm putting this on hold until I discuss with our infrastructure team how to best deploy this to a subdomain. It could be that this work will be the initial commit of a completely separate repository. I'm super excited to get documentation up in this manner though - thank you for moving us one huge leap forward.
@kylemh Did you ever get clarification re the subdomain?
It was on Infra's roadmap, along with many other items, I'm sure.