Skip to content

Commit

Permalink
docs: clarify documentation guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
penovicp committed Oct 6, 2023
1 parent 8e058fb commit 8fa7598
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions www/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,7 @@ Official documentation is available to users at [www.starknetjs.com](https://www

## Update documentation

Do not forget to include your methods documentation directly in your source code, in accordance with [JSDoc](https://jsdoc.app/) rules. Then you have to update manually the API documentation in `/www/docs/API` of your branch.
If you need to update some guides, modify the files in `/www/docs/guides` of your branch.
The administrators of the project will handle your PR:
Appropriate [JSDoc](https://jsdoc.app/) comments should be included in the source code. Such comments are used to populate the content for `/www/docs/API`, this content will be automatically generated by the project CI, and should not be included in Pull Requests. The content for `/www/docs/guides` should be updated manually and the modifications should be included in Pull Requests.

### Without creation of a new realease of Starknet.js

Expand Down

0 comments on commit 8fa7598

Please sign in to comment.