search

CosmWasm / docs-old

Documentation for cosmwasm
https://www.cosmwasm.com/
Creative Commons Attribution Share Alike 4.0 International
2 stars 6 forks source link

Docs migration #47

Closed lovincyrus closed 4 years ago

lovincyrus commented 4 years ago

Live: https://cosmwasm-docs.netlify.app

Next steps:

ethanfrey commented 4 years ago

I took a look and the design is quite nice. I am happy to wait until next week when the theme is properly published and then we can move over the docs.

One issue I found is the left sidebar. Look at https://cosmwasm-docs.netlify.app/getting-started/first-demo.html vs https://www.cosmwasm.com/docs/getting-started/first-demo

[This file contains the ordering of pages]((https://github.com/CosmWasm/docs/blob/master/website/sidebars.json) within each section (note that one page is hidden and just linked from another - solutions on how to solve if you are stuck)

I'm sure there is a way to do that with the vuepress theme. Otherwise, :rocket: :guitar: :rabbit:

ethanfrey commented 4 years ago

I also noticed the syntax highlighting on the code is gone. I think this all comes from highlight.js under the hood. It would be cool if vuepress also supported this (as I will have quite some code samples)

lovincyrus commented 4 years ago

One issue I found is the left sidebar. Look at https://cosmwasm-docs.netlify.app/getting-started/first-demo.html vs https://www.cosmwasm.com/docs/getting-started/first-demo

[This file contains the ordering of pages]((https://github.com/CosmWasm/docs/blob/master/website/sidebars.json) within each section (note that one page is hidden and just linked from another - solutions on how to solve if you are stuck)

Gotcha - I've only updated the /intro page so far. You may update the rest by tweaking the order: 1 in each .md file. (fixed)

lovincyrus commented 4 years ago

I also noticed the syntax highlighting on the code is gone. I think this all comes from highlight.js under the hood. It would be cool if vuepress also supported this (as I will have quite some code samples)

VuePress is currently using Prism for its syntax highlighting. I'll take a look at why it's not working for the rust code.

Reference: https://vuepress.vuejs.org/guide/markdown.html#syntax-highlighting-in-code-blocks

ethanfrey commented 4 years ago

VuePress is currently using Prism for its syntax highlighting. I'll take a look at why it's not working for the rust code.

Odd, Rust support seems to be present in Prism.js for years... https://github.com/PrismJS/prism/pull/430

I did notice the examples seemed to start with "language" rather than "language", maybe the space is necessary?

lovincyrus commented 4 years ago

Odd, Rust support seems to be present in Prism.js for years... PrismJS/prism#430

The syntax highlighting for rust should be fixed in this PR https://github.com/tendermint/cosmos-ui/pull/201/files#diff-0067b8cefd607df5bea9785b2a502e69R404

ethanfrey commented 4 years ago

This still needs an updated logo, right (we are working on it). Otherwise, from your end, this is ready to go?

ethanfrey commented 4 years ago

I guess the netlify docs are not updated yet with the rust patch?

https://cosmwasm-docs.netlify.app/getting-started/editing-escrow-contract.html

When this is all ready, I am happy to merge and deploy tomorrow or next week. We should have a logo in a week or two as well :crossed_fingers:

lovincyrus commented 4 years ago

I guess the netlify docs are not updated yet with the rust patch?

https://cosmwasm-docs.netlify.app/getting-started/editing-escrow-contract.html

Just deployed the latest version to Netlify! 🚀

lovincyrus commented 4 years ago

This still needs an updated logo, right (we are working on it). Otherwise, from your end, this is ready to go?

Yes!

ethanfrey commented 4 years ago

Just deployed the latest version to Netlify! :rocket:

Great. I checked it out and it looks much nicer. Not quite as good as my IDE :wink: but nice highlighting. Logo should come in 1-2 weeks.

Is there a README on how to deploy? It seems only the docs dir matters now (we will pull out the website into a separate place - actually static rather than docs homepage). I guess this is how I would deploy it?

cd docs
yarn install
yarn build
// then deploy the build scripts somewhere??

And this seems like the proper docs to set up github pages (or other) deployment: https://vuepress.vuejs.org/guide/deploy.html#github-pages correct?

I will dig into this next week to make it live. Thank you for the help.

lovincyrus commented 4 years ago

Is there a README on how to deploy? It seems only the docs dir matters now (we will pull out the website into a separate place - actually static rather than docs homepage). I guess this is how I would deploy it?

cd docs
yarn install
yarn build
// then deploy the build scripts somewhere??

And this seems like the proper docs to set up github pages (or other) deployment: https://vuepress.vuejs.org/guide/deploy.html#github-pages correct?

I wrote up a DOCS_README. But, that's the gist of it. You just need to use a deployment service of your choice and deploy the dir in docs/.vuepress/dist.

Example: https://default-docs.netlify.app/ image

You can refer to https://default-docs.netlify.app/basic/03-used-by.html for more examples.