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.

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

Add solidity docs tool #3329

Merged
merged 8 commits into from
Mar 26, 2024

Conversation

Dr-Electron
Copy link
Contributor

@Dr-Electron Dr-Electron commented Mar 9, 2024

Description of change

I added a tool to create solidity docs and a workflow to upload the generated docs for the wiki. I just added some AI generated docs for testing. Would be nice if your team could document all interfaces and functions. There is a lot of flexibility in this tool, so feel free to give suggestions. You can find a preview in my Wiki PR

Type of change

  • Documentation Enhancement

How the change has been tested

Change checklist

  • I have followed the contribution guidelines for this project
  • I have performed a self-review of my own code
  • I have selected the develop branch as the target branch
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation

@Dr-Electron Dr-Electron force-pushed the add-solidity-docs-tool branch from 5badb06 to 3ae01a8 Compare March 9, 2024 20:34
@jorgemmsilva jorgemmsilva enabled auto-merge March 26, 2024 08:49
@jorgemmsilva jorgemmsilva merged commit d8352cc into iotaledger:develop Mar 26, 2024
5 checks passed
@Dr-Electron Dr-Electron deleted the add-solidity-docs-tool branch March 26, 2024 09:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants