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

docs(getting_started,fill): add solc instructions for arm64 users with fill issues #1217

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

felix314159
Copy link
Collaborator

@felix314159 felix314159 commented Feb 14, 2025

🗒️ Description

When using ARM64 you can't use the solc x86-64 that you end up with when following the old instructions in the docs. Updated the docs with a guide to install solc on ARM and a description of the fill issue that would have resulted if an ARM user would not have followed these instructions.

🔗 Related Issues

✅ Checklist

  • All: Set appropriate labels for the changes.
  • All: Considered squashing commits to improve commit history.
  • All: Added an entry to CHANGELOG.md.
  • All: Considered updating the online docs in the ./docs/ directory.
  • Tests: Ran mkdocs serve locally and verified the auto-generated docs for new tests in the Test Case Reference are correctly formatted.

Copy link
Member

@danceratopz danceratopz left a comment

Choose a reason for hiding this comment

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

Thanks a lot for adding this, nice that we have ARM users covered too!

Few suggestions below.

@danceratopz danceratopz changed the title docs(getting_started,fill): added solc building instructions for arm64 users with fill issues docs(getting_started,fill): add solc instructions for arm64 users with fill issues Feb 14, 2025
@danceratopz danceratopz added scope:docs Scope: Documentation scope:fill Scope: fill command labels Feb 14, 2025
Copy link
Member

@danceratopz danceratopz left a comment

Choose a reason for hiding this comment

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

Thanks for adding the suggestions, @felix314159.

Following Spencer's offline comment about macOS ARM64, it seems that we need to be a little more precise about the platforms.

@spencer-tb do these make sense to you?

uv sync --all-extras
uv run solc-select use 0.8.24 --always-install
```
=== "x86-64"
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
=== "x86-64"
=== "All x86-64 platforms and ARM64 macOS"

@spencer-tb
Copy link
Collaborator

This looks good to me and happy with this as is!

Although maybe its clearer to keep the initial installation commands as they were before, pointing people to troubleshooting directly afterwards. Not that architecture is hard to check, but for the basic new user it might be!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope:docs Scope: Documentation scope:fill Scope: fill command
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants