Skip to content

Commit

Permalink
solidity docs
Browse files Browse the repository at this point in the history
  • Loading branch information
trajan0x committed Jan 8, 2025
1 parent a100d0f commit 5caf0bb
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
Binary file added .github/workflows/assets/root-dir.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 17 additions & 0 deletions .github/workflows/solidity.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Configuring a New Vercel Project for Solidity Documentation

Since we're using Vercel via github actions rather than the UI, configuring a new project requires a little extra work.

1. Click "Add New" on the home screen.
2. The project creation page will force you to import a project from github. Select any non-private repo, as this will be disconnected later.
![create project](./assets/vercel-create-project.png)me
3. Go to the settings->git and disconnect the repo.
![disconnect repo](./assets/vercel-git-page.png)
4. Get the project id from vercel.
![project id](./assets/vercel-project-id.png)
5. Set the root directory to the path in the repo where your package is located + docs
![root directory](./assets/vercel-root-dir.png)
6. [Add this variable as a secret to github actions](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository). As a convention this should be called `VERCEL_[PACKAGE_NAME]_DOCS_PROJECT_ID` (e.g. `VERCEL_CONTRACT_DOCS_PROJECT_ID` for contracts-core).
7. Add the project id to the PROJECT_IDS mapping in [solidity.yml](./solidity.yml) under the "Get Project ID" step.

Now you're done. Any time you push to the main branch, the Solidity documentation will be deployed to vercel.

0 comments on commit 5caf0bb

Please sign in to comment.