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

Prepare input for Docusaurus documentation #303

Closed
rianhughes opened this issue Sep 1, 2023 · 2 comments
Closed

Prepare input for Docusaurus documentation #303

rianhughes opened this issue Sep 1, 2023 · 2 comments
Assignees
@aquental
Labels
Documentation

Comments

@rianhughes
Copy link
Contributor

rianhughes commented Sep 1, 2023 •
edited by stranger80
Loading

See docusaurus, Juno.

This task is to bring the Starknet.go source code comments to the level such that Docusaurus artifacts can be generated from them.
Also include the script required to generate the Docusaurus content.
@rianhughes rianhughes assigned rianhughes and unassigned rianhughes Sep 1, 2023
@aquental
Copy link
Contributor

aquental commented Sep 1, 2023

Thanks, I'll start documenting it.

@rianhughes rianhughes assigned rianhughes and aquental and unassigned rianhughes Sep 1, 2023
@stranger80 stranger80 mentioned this issue Oct 3, 2023
Closed
aquental added a commit to aquental/starknet.go that referenced this issue Oct 10, 2023
@aquental
Code comments (issue NethermindEth#303).
de70974
@aquental aquental mentioned this issue Oct 10, 2023
Merged
@aquental
Copy link
Contributor

Created Pull Request (#415)

@stranger80 stranger80 changed the title Create documentation Prepare input for Docusaurus documentation Oct 17, 2023
cicr99 pushed a commit that referenced this issue Oct 27, 2023
@aquental
Code comments (issue #303). (#415)
c6e1d4c 
* Code comments (issue #303).

* updted 'account' directory files

* updated 'curve' directory files

* updated 'devnet' directory files

* updated 'examples' directory files

* updated 'hash' directory files

* updated 'merkle' directory files

* updated 'mocks' directory files

* updated 'typed' directory files

* updated 'utils' directory files

* updated 'rpc' directory files

* format files and update parameter description

* fixed comment for SpecVersion

* fixed comment for PendingTransaction

* Fix package typo at types_transaction.go

* Fix TestTransactionTrace at trace_test.go

* Fix GetRandomPrivateKey from curve.go
@cicr99 cicr99 closed this as completed Oct 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@aquental aquental

Labels
Documentation
Projects
[Nubia] Starknet.go
Status: ✅ Done
Milestone
No milestone
Development

No branches or pull requests
4 participants
@aquental @stranger80 @rianhughes @cicr99