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

Fix Solidity Docgen Config #730

Closed
3 of 6 tasks
kyzooghost opened this issue Feb 26, 2025 · 0 comments
Closed
3 of 6 tasks

Fix Solidity Docgen Config #730

kyzooghost opened this issue Feb 26, 2025 · 0 comments
Assignees
Labels
Contracts Smart Contract related TechDebt Technical Debt

Comments

@kyzooghost
Copy link
Contributor

Description

When we did the /contracts folder structure rehaul in #420, we did not update the Solidity docgen configuration accordingly. We would like to amend this.

Motivation

Eliminate untracked Markdown files being created by Solidity docgen during the husky hooks.

Tasks

  • Update Solidicty docgen configuration

Acceptance criteria

  • CI passing

Risks

  • Negligible

Remember to

  • Add the documentation label in case there is an impact on the documentation
  • Add priority and team labels
  • Add Task for updating the Runbook or adding/updating existing metrics and alerts.
@kyzooghost kyzooghost added Contracts Smart Contract related TechDebt Technical Debt labels Feb 26, 2025
@kyzooghost kyzooghost self-assigned this Feb 26, 2025
@kyzooghost kyzooghost changed the title Fix Solidity Docgen Fix Solidity Docgen Config Feb 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Contracts Smart Contract related TechDebt Technical Debt
Projects
None yet
Development

No branches or pull requests

1 participant