Skip to content

Commit

Permalink
updated the contributor s page
Browse files Browse the repository at this point in the history
  • Loading branch information
Imod7 committed Nov 20, 2024
1 parent 2c46253 commit 367894c
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions guides/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,8 @@ where reviewers will be able to review your changes made.
- If you add a new endpoint or update an existing one (by modifying its parameters or output), you will also need to update the documentation (OpenApi specs). Here are some common steps to follow in order to do that:
- Update this [file](https://github.com/paritytech/substrate-api-sidecar/blob/master/docs/src/openapi-v1.yaml) by adding or updating the corresponding endpoint description in the `paths` and `schemas` sections.
- After you complete the changes, verify that the `yaml` file has no errors by copying the contents of this [file](https://github.com/paritytech/substrate-api-sidecar/blob/master/docs/src/openapi-v1.yaml) into the [Swagger Editor](https://editor.swagger.io/) or the [New Swagger Editor](https://editor-next.swagger.io/).
- If there are no errors, run `yarn build:docs` from the root directory of this repository. This will make sure that the `dist` is updated with the current changes.
- Next, open the `docs/dist/index.html` page (by copying its path) in your browser to confirm that all changes have been applied and appear as expected.
- If everything looks good, push the changes.
- To preview the docs locally, you can run `yarn build:docs` from the root directory of this repository. This will update the `docs/dist/index.html` page which you can open (by copying its path) in your browser and verify that the content appear as expected. Please do not push/commit this file (or the `dist` folder) in your PR since this is not necessary. The docs will be build and published automatically in Github pages from the workflow ([docs.yml](https://github.com/paritytech/substrate-api-sidecar/blob/master/.github/workflows/docs.yml)).

## Rules

Expand Down

0 comments on commit 367894c

Please sign in to comment.