docs: Updates and Syntax Corrections #2396
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes Overview
1. README.md
2. docs/userguides/compile.md
vyper.compile(Path("path/to/contract.sol"))
solidity.compile(Path("path/to/contract.sol"))
vyper
tosolidity
since the file being compiled is a Solidity contract (.sol extension).3. docs/userguides/scripts.md
Summary
These changes improve documentation clarity, fix a technical inaccuracy in the compiler reference, and maintain consistent punctuation throughout the documentation. The updates make the documentation more professional and accurate for users of the Ape framework.