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

#177 gh-pages for the repo #282

Merged
merged 7 commits into from
Dec 20, 2022
Merged

#177 gh-pages for the repo #282

merged 7 commits into from
Dec 20, 2022

Conversation

shramee
Copy link
Contributor

@shramee shramee commented Dec 17, 2022

Usage related changes

Development related changes

  • Added ./www with docusaurus stuff.
  • Changes in README.md should be updated in ./www/docs/intro.md
  • Changes in README-dev.md should be updated in ./www/docs/dev.md
  • Deployment:
cd www
npm install
USE_SSH=true npm run deploy

Checklist:

  • Formatted the code
  • No linter errors + tried to avoid introducing linter warnings
  • Performed a self-review of the code
  • Rebased to the last commit of the target branch (or merged it into my branch)
  • Documented the changes
    • If src/type-extensions.ts was changed, updated the line number referencing this file in the ## API section of README.md
  • Updated the test directory (with a test case consisting of network.json, hardhat.config.ts, check.ts)
  • Linked issues which this PR resolves
  • Created a PR to the plugin branch of starknet-hardhat-example:
    • < EXAMPLE_REPO_PR_URL >
    • Modified test.sh to use my example repo branch
    • Restored test.sh to to use the original branch (after the example repo PR has been merged)
  • All tests are passing (for external contributors who don't have access to the CI/CD pipeline)

@shramee
Copy link
Contributor Author

shramee commented Dec 17, 2022

#177 gh-pages with Docusaurus.

@FabijanC FabijanC self-requested a review December 19, 2022 08:54
Copy link
Collaborator

@FabijanC FabijanC left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, looks great! Made a few comments. Once merged, I will edit our current README.md to include a link to the page.

package.json Outdated Show resolved Hide resolved
www/src/pages/markdown-page.md Show resolved Hide resolved
@shramee
Copy link
Contributor Author

shramee commented Dec 20, 2022

@FabijanC Updates here,
dd38b5a

@FabijanC FabijanC changed the title #177 gh-pages for the repo gh-pages for the repo Dec 20, 2022
@FabijanC FabijanC merged commit ee4d02a into 0xSpaceShard:master Dec 20, 2022
@shramee shramee changed the title gh-pages for the repo #177 gh-pages for the repo Jan 17, 2023
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.

Create Github pages for this repo
2 participants