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.

Sign up for GitHub

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

Jump to bottom

Create Github pages for this repo #177

Closed
ivpavici opened this issue Jul 26, 2022 · 6 comments · Fixed by #282
Closed

Create Github pages for this repo #177

ivpavici opened this issue Jul 26, 2022 · 6 comments · Fixed by #282
Assignees
@shramee
Labels
documentation Improvements or additions to documentation OnlyDust Open for OnlyDust contributors

Comments

@ivpavici
Copy link
Contributor

ivpavici commented Jul 26, 2022 •
edited
Loading

Docusaurus could be used.
Example: https://shard-labs.github.io/starknet-devnet/
@ivpavici ivpavici added the documentation Improvements or additions to documentation label Jul 26, 2022
@ivpavici ivpavici moved this to 🆕 New in starknet-hardhat-plugin Jul 26, 2022
@ivpavici ivpavici added the OnlyDust Open for OnlyDust contributors label Dec 6, 2022
@shramee
Copy link
Contributor

shramee commented Dec 15, 2022

Happy to work on this.

@FabijanC
Copy link
Collaborator

Hi @shramee and thanks for your interest - I assigned you. I guess it should be enough to cover README.md, and not README-dev.md, wdyt @ivpavici?

@ivpavici
Copy link
Contributor Author

We can add both, why not, README-dev.md can be under a page called Guides, or something?
@shramee you can take a look at https://www.starknetjs.com/ , it's using Docusaurus

shramee referenced this issue in shramee/starknet-hardhat-plugin Dec 17, 2022
@shramee
Adding docusaurus
9c0c2c6
shramee referenced this issue in shramee/starknet-hardhat-plugin Dec 17, 2022
@shramee
Removing unused files
5af5ac3
shramee referenced this issue in shramee/starknet-hardhat-plugin Dec 17, 2022
@shramee
Initial version
39c24ae 
No sidebar
Initial content
Docusaurus config
Theming
Logo
Home content
shramee referenced this issue in shramee/starknet-hardhat-plugin Dec 17, 2022
@shramee
Home page
de6c4dc
@shramee shramee mentioned this issue Dec 17, 2022
Merged
12 tasks
@shramee
Copy link
Contributor

shramee commented Dec 17, 2022

Apologies for the delay on this one guys,
Here's a preview - https://shramee.github.io/starknet-hardhat-plugin/

Deployment,

cd www
npm install
USE_SSH=true npm run deploy

@ivpavici
Copy link
Contributor Author

looks good, only questions is do we keep it all in one page, or break into multiple pages? wdyt @FabijanC ?

@FabijanC
Copy link
Collaborator

FabijanC commented Dec 19, 2022 •
edited
Loading

@ivpavici I think having it in one page makes searching the docs easier. Thanks @shramee

Repository owner moved this from 🆕 New to ✅ Done in starknet-hardhat-plugin Dec 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@shramee shramee

Labels
documentation Improvements or additions to documentation OnlyDust Open for OnlyDust contributors
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

#177 gh-pages for the repo shramee/starknet-hardhat-plugin
3 participants
@ivpavici @shramee @FabijanC