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: Inconsistent usage of Solidity and related terms #1479

Open
xermicus opened this issue Aug 8, 2023 · 0 comments
Open

Docs: Inconsistent usage of Solidity and related terms #1479

xermicus opened this issue Aug 8, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@xermicus
Copy link
Contributor

xermicus commented Aug 8, 2023

We are not very consistent about how we use Solidity in our docs. We just use Solidity, sometimes Solang Solidity, Solidity on Solana, Ethereum Solidity etc...

This leads to discussions and unclear situations as to when what term should be used. We should define terms for each dialect, including what's used on EVM, and then overhaul the docs to achieve some consistency.

Additionally the following was noted regarding linking to other external documentation:

- Neither the `solc` compiler nor the `docs.soliditylang.org` resemble a language spec.
- Hence it's questionable whether this is authoritative because it's merely the predominant dialect or version of Solidity at the time of writing.
- Add to that, seeing the compiler or docs of a version of Solidity that can only run on a specific runtime as authority is definitively not what we want.
- From that follows, saying just `Solidity` while linking to some specific documentation or implementation should be avoided. Because it implies that the documentation or implementation linked to to be an authoritative source while it is not.
@xermicus xermicus changed the title It was noted that we are not very consistent about how we use Solidity in our docs. Docs: Inconsistent usage of Solidity and related terms Aug 8, 2023
@xermicus xermicus added the enhancement New feature or request label Aug 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants
@xermicus and others