Skip to content

Commit

Permalink
chore: remove documentation files from core repository
Browse files Browse the repository at this point in the history
  • Loading branch information
0xArdy committed Oct 25, 2023
1 parent a5f05d5 commit debd1b1
Show file tree
Hide file tree
Showing 49 changed files with 10 additions and 1,903 deletions.
62 changes: 0 additions & 62 deletions .github/workflows/docs.yml

This file was deleted.

22 changes: 10 additions & 12 deletions README.md
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

This file was deleted.

20 changes: 0 additions & 20 deletions docs/book.toml

This file was deleted.

89 changes: 0 additions & 89 deletions docs/src/SUMMARY.md

This file was deleted.

16 changes: 0 additions & 16 deletions docs/src/content/core/README.md

This file was deleted.

26 changes: 0 additions & 26 deletions docs/src/content/core/module.md

This file was deleted.

51 changes: 0 additions & 51 deletions docs/src/content/core/oracle.md

This file was deleted.

7 changes: 0 additions & 7 deletions docs/src/content/extensions/README.md

This file was deleted.

Loading

0 comments on commit debd1b1

Please sign in to comment.