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

chore: remove docs files from core repository #5

Closed
wants to merge 1 commit into from
Closed

chore: remove docs files from core repository #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 0 additions & 62 deletions .github/workflows/docs.yml
View file
Open in desktop

This file was deleted.

22 changes: 10 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,16 @@ yarn build

Make sure to set `OPTIMISM_RPC` environment variable before running end-to-end tests.

| Yarn Command | Description |
| ------------------------- | ------------------------------------------------------------------------------------------------- |
| `yarn build` | Compile all contracts. |
| `yarn coverage` | See `forge coverage` report. |
| `yarn deploy` | Deploy the contracts to Optimism mainnet. |
| `yarn deploy:local` | Deploy the contracts to a local fork. |
| `yarn docs:build` | Generate documentation with [`forge doc`](https://book.getfoundry.sh/reference/forge/forge-doc). |
| `yarn docs:run` | Start the documentation server. |
| `yarn test` | Run all unit and integration tests. |
| `yarn test:unit` | Run unit tests. |
| `yarn test:integration` | Run integration tests. |
| `yarn test:gas` | Run all unit and integration tests, and make a gas report. |
| Yarn Command | Description |
| ----------------------- | ---------------------------------------------------------- |
| `yarn build` | Compile all contracts. |
| `yarn coverage` | See `forge coverage` report. |
| `yarn deploy` | Deploy the contracts to Optimism mainnet. |
| `yarn deploy:local` | Deploy the contracts to a local fork. |
| `yarn test` | Run all unit and integration tests. |
| `yarn test:unit` | Run unit tests. |
| `yarn test:integration` | Run integration tests. |
| `yarn test:gas` | Run all unit and integration tests, and make a gas report. |

## Licensing

Expand Down
63 changes: 0 additions & 63 deletions build-docs.sh
View file
Open in desktop

This file was deleted.

20 changes: 0 additions & 20 deletions docs/book.toml
View file
Open in desktop

This file was deleted.

89 changes: 0 additions & 89 deletions docs/src/SUMMARY.md
View file
Open in desktop

This file was deleted.

16 changes: 0 additions & 16 deletions docs/src/content/core/README.md
View file
Open in desktop

This file was deleted.

26 changes: 0 additions & 26 deletions docs/src/content/core/module.md
View file
Open in desktop

This file was deleted.

51 changes: 0 additions & 51 deletions docs/src/content/core/oracle.md
View file
Open in desktop

This file was deleted.

7 changes: 0 additions & 7 deletions docs/src/content/extensions/README.md
View file
Open in desktop

This file was deleted.

Loading
Loading