Renames to CaminoJS #6
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Ayagoumi
approved these changes
Oct 26, 2022
documentation/e2e-tests.md
Outdated
|
|
||
| For testing end to end, you need to have a local network running. This can easily be achieved by using Avalanche Network Runner. You can follow the steps [here](https://docs.avax.network/quickstart/network-runner) to setup a local network. | ||
| For testing end to end, you need to have a local network running. This can easily be achieved by using Camino Network Runner. You can follow the steps [here](https://docs.avax.network/quickstart/network-runner) to setup a local network. |
documentation/generating-typedoc.md
Outdated
| Confirm that everything worked by running `yarn start` and viewing the new CaminoJS docs on `localhost`. If that is successful next run `yarn build` to confirm that docusaurus is able to properly build. Once that is successful, branch off of `master`, commit your changes and push them on your new feature branch to the remote `avalanche-docs` repo and create a PR. |
There was a problem hiding this comment.
avalanche-docs should be changes to camino-docs
documentation/generating-typedoc.md
Outdated
| @@ -45,4 +45,4 @@ Now copy the `api.md` file into the `/path/to/docs/apis/tools/avalanchejs/` dire | |||
|
|
|||
| Next copy 3 directories, `classes/`, `interfaces/` and `modules/` into the `/path/to/avalanchejs-docs/` directory of your local `avalanchejs-docs/` repo. | |||
There was a problem hiding this comment.
avalanche-docs should be changed to camino-docs
.github/workflows/e2e.yml
Outdated
| @@ -29,23 +29,23 @@ jobs: | |||
| mkdir -p $GOPATH/$AVAPATH | |||
There was a problem hiding this comment.
$AVAPATH should also change to $CAMPATH
Ayagoumi
requested changes
Oct 26, 2022
Ayagoumi
requested changes
Oct 26, 2022
|
|
||
| ## Overview | ||
|
|
||
| We use [typedoc](https://typedoc.org) to turn comments in our typescript into markdown pages which can be copied into [the Avalanche Docs repo](https://github.com/ava-labs/avalanche-docs) and [the AvalancheJS Docs repo](https://github.com/ava-labs/avalanchejs-docs). Each time a new version of AvalancheJS gets deployed to [npm](https://www.npmjs.com/package/avalanche) then typedocs should be regenerated and pasted into the both docs repo previously mentioned. | ||
| We use [typedoc](https://typedoc.org) to turn comments in our typescript into markdown pages which can be copied into [the CaminoJS Docs repo](https://github.com/chain4travel/caminojs-docs). Each time a new version of CaminoJS gets deployed to [npm](https://www.npmjs.com/package/@c4tplatform/caminojs) then typedocs should be regenerated and pasted into the both docs repo previously mentioned. |
There was a problem hiding this comment.
Camino Docs doesn't exist either change this or we should change the name of the repo CaminoJs Docs
documentation/generating-typedoc.md
Outdated
| * Nest the list items per their parent category | ||
| * Clean up the body copy. Ex: `API-AVM` -> `AVM` and `API-AVM-Credentials` -> `Credentials` | ||
|
|
||
| ## Copy to Docs Repo | ||
|
|
||
| Now copy the `api.md` file into the `/path/to/docs/apis/tools/avalanchejs/` directory of your local `avalanche-docs/` repo. | ||
| Now copy the `api.md` file into the `/path/to/docs/apis/tools/avalanchejs/` directory of your local `camino-docs/` repo. |
documentation/generating-typedoc.md
Outdated
| * Nest the list items per their parent category | ||
| * Clean up the body copy. Ex: `API-AVM` -> `AVM` and `API-AVM-Credentials` -> `Credentials` | ||
|
|
||
| ## Copy to Docs Repo | ||
|
|
||
| Now copy the `api.md` file into the `/path/to/docs/apis/tools/avalanchejs/` directory of your local `avalanche-docs/` repo. | ||
| Now copy the `api.md` file into the `/path/to/docs/apis/tools/avalanchejs/` directory of your local `camino-docs/` repo. | ||
|
|
||
| Next copy 3 directories, `classes/`, `interfaces/` and `modules/` into the `/path/to/avalanchejs-docs/` directory of your local `avalanchejs-docs/` repo. |
There was a problem hiding this comment.
avalanchejs-docs/ should be changed to caminojs-docs/
| Confirm that everything worked by running `yarn start` and viewing the new CaminoJS docs on `localhost`. If that is successful next run `yarn build` to confirm that docusaurus is able to properly build. Once that is successful, branch off of `master`, commit your changes and push them on your new feature branch to the remote `camino-docs` repo and create a PR. |
There was a problem hiding this comment.
if the docs repo was renamed this should be changed too.
.github/workflows/e2e.yml
Outdated
| cd camino-network-runner | ||
| git checkout v0.1.4 | ||
| go run ./examples/local/fivenodenetwork/main.go & | ||
| - name: AvalancheJS E2E Test | ||
| - name: CaminoJS E2E Test | ||
| env: | ||
| AVALANCHEGO_IP: localhost |
There was a problem hiding this comment.
AVALANCHEGO_IP and AVALANCHEGO_PORT should be changed to CAMINOGO_IP and CAMINO_PORT
Chriserus
force-pushed
the
caminojs-renames
branch
from
f329cb6 to
8ff57e8
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.