Skip to content

Documentation updates - #2958

Open
naddison36 wants to merge 7 commits into
masterfrom
nicka/doc-changes
Open

Documentation updates#2958
naddison36 wants to merge 7 commits into
masterfrom
nicka/doc-changes

Conversation

@naddison36

@naddison36 naddison36 commented Aug 3, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Remove remaining OpenZeppelin Defender-specific configuration, signer handling, and test constants.
  • Refresh repository documentation to reflect the current Foundry deployment framework, CI workflow, and supported networks.
  • Update Talos documentation:
    • regenerate the action inventory from current action sources;
    • replace migration-focused action guidance with ongoing Talos action development and maintenance guidance;
    • remove obsolete Hardhat/Defender references.
  • Remove stale historical records and unused Harvester documentation.

@sparrowDom sparrowDom left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a couple of comments

Comment thread contracts/README.md
There are separate actions for:

- Contract formatting and linting
- Dapp formatting and linting

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can remove this part

Comment thread contracts/README.md

## Coverage

The Hardhat plug-in [solidity-coverage](https://github.com/sc-forks/solidity-coverage#solidity-coverage) is used to gather Solidity code coverage. The configuration is in [.solcover.js](./.solcover.js). The coverage output is written to `coverage.json`.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This part is also probably obsolete

Comment thread contracts/README.md

### Echidna tests

[Echidna](https://github.com/crytic/echidna#echidna-a-fast-smart-contract-fuzzer-) is used for fuzzing tests.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Echidna also doesn't work anymore. @clement-ux this is a known thing?

@@ -486,31 +463,32 @@ All three identifiers **must match exactly** — if they drift, the script will
// SPDX-License-Identifier: MIT
pragma solidity 0.8.23;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should probably be:

pragma solidity 0.8.28

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also All 3 000_Example.s.sol files pin solidity to:

pragma solidity ^0.8.0;

which should probably be updated to:

pragma solidity 0.8.28

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.

2 participants