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

Update the "Resources" section in the docs #15076

Merged
merged 10 commits into from
Nov 28, 2024
Merged

Conversation

mehtavishwa30
Copy link
Contributor

@mehtavishwa30 mehtavishwa30 commented May 6, 2024

Closes #15339
Closes #15234
Closes #15575

docs/resources.rst Outdated Show resolved Hide resolved
@cameel cameel changed the title Update resources.rst Update the "Resources" section in the docs May 16, 2024
@github-actions github-actions bot added the stale The issue/PR was marked as stale because it has been open for too long. label May 30, 2024
@nikola-matic nikola-matic removed the stale The issue/PR was marked as stale because it has been open for too long. label Jun 3, 2024
@github-actions github-actions bot added the stale The issue/PR was marked as stale because it has been open for too long. label Jun 18, 2024
Copy link

This pull request was closed due to a lack of activity for 7 days after it was stale.

docs/resources.rst Outdated Show resolved Hide resolved
docs/resources.rst Outdated Show resolved Hide resolved
@cameel cameel removed stale The issue/PR was marked as stale because it has been open for too long. closed-due-inactivity labels Aug 30, 2024
@stackenbotten
Copy link

There was an error when running chk_coding_style for commit d7acf86da2b0a8d7db347b43ff18fcea125e864b:

Error: Trailing whitespace found:
docs/resources.rst:41:        Browser-based IDE with integrated compiler and Solidity runtime environment without server-side components.    

Please check that your changes are working as intended.

@mehtavishwa30 mehtavishwa30 force-pushed the mehtavishwa30-patch-1 branch from 37818e0 to 81d0ed4 Compare August 30, 2024 14:35
Copy link

This pull request is stale because it has been open for 14 days with no activity.
It will be closed in 7 days unless the stale label is removed.

@github-actions github-actions bot added the stale The issue/PR was marked as stale because it has been open for too long. label Sep 14, 2024
@mehtavishwa30
Copy link
Contributor Author

Relevant

@mehtavishwa30 mehtavishwa30 removed the stale The issue/PR was marked as stale because it has been open for too long. label Sep 14, 2024
r0qs
r0qs previously approved these changes Sep 16, 2024
Copy link
Member

@r0qs r0qs left a comment

Choose a reason for hiding this comment

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

The changes look good to me now, we just need to squash the commits. I was also wondering if we could merge the changes proposed in this PR: #15339, or possibly even close it. I haven’t looked too closely at the tools being proposed - although the static analyzer seems nice - but since we're working on the same docs and there’s some overlap in the changes, this might be a good time to make a decision on that.

Comment on lines 10 to 15
* `Solidity website <https://soliditylang.org/>`_
* `Solidity changelog <https://github.com/ethereum/solidity/blob/develop/Changelog.md>`_
* `Solidity codebase on GitHub <https://github.com/ethereum/solidity/>`_
* `Solidity language users chat <https://matrix.to/#/#ethereum_solidity:gitter.im>`_
* `Solidity compiler developers chat <https://matrix.to/#/#ethereum_solidity-dev:gitter.im>`_
* `awesome-solidity <https://github.com/bkrem/awesome-solidity>`_
Copy link
Member

@r0qs r0qs Sep 16, 2024

Choose a reason for hiding this comment

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

This still not in alphabetical order, but I guess the idea was to keep it as it was before, right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That's correct. Just made minor naming changes in the title that I thought were more appropriate. But otherwise, I'm not strongly set on the order.

@mehtavishwa30
Copy link
Contributor Author

The changes look good to me now, we just need to squash the commits. I was also wondering if we could merge the changes proposed in this PR: #15339, or possibly even close it. I haven’t looked too closely at the tools being proposed - although the static analyzer seems nice - but since we're working on the same docs and there’s some overlap in the changes, this might be a good time to make a decision on that.

@r0qs Thanks for the review. I wanted to get to this today. Just caught up in some other issues. The idea is to consolidate the changes proposed in the external contribution, so I will ask for a final review once I've included those. :)

@mehtavishwa30 mehtavishwa30 marked this pull request as draft September 16, 2024 12:43
@r0qs
Copy link
Member

r0qs commented Sep 16, 2024

The changes look good to me now, we just need to squash the commits. I was also wondering if we could merge the changes proposed in this PR: #15339, or possibly even close it. I haven’t looked too closely at the tools being proposed - although the static analyzer seems nice - but since we're working on the same docs and there’s some overlap in the changes, this might be a good time to make a decision on that.

@r0qs Thanks for the review. I wanted to get to this today. Just caught up in some other issues. The idea is to consolidate the changes proposed in the external contribution, so I will ask for a final review once I've included those. :)

No problem. But yeah, that was just a suggestion though, because we have so many documentation PRs that have small changes, that maybe we could combine some of them. For example, this may also be relevant to add here or just close it: #15234

@mehtavishwa30 mehtavishwa30 marked this pull request as ready for review October 25, 2024 13:45
@github-actions github-actions bot added the stale The issue/PR was marked as stale because it has been open for too long. label Nov 9, 2024
@mehtavishwa30 mehtavishwa30 removed the stale The issue/PR was marked as stale because it has been open for too long. label Nov 12, 2024
@stackenbotten
Copy link

There was an error when running chk_coding_style for commit 89489df1308512ba3b3da3413ea94d5691e22a9e:

Error: Trailing whitespace found:
docs/resources.rst:74:* Visual Studio Code (VS Code)    

Please check that your changes are working as intended.

docs/resources.rst Outdated Show resolved Hide resolved
* `Solidity website <https://soliditylang.org/>`_
* `Solidity changelog <https://github.com/ethereum/solidity/blob/develop/Changelog.md>`_
* `Solidity codebase on GitHub <https://github.com/ethereum/solidity/>`_
* `Solidity language users chat <https://matrix.to/#/#ethereum_solidity:gitter.im>`_
Copy link
Collaborator

Choose a reason for hiding this comment

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

Why did you move this to lower caps? The previous style is more consistent with the rest of our docs.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

it just looked a little weird, IMO, in that earlier format. But I don't think it's too big of a deal. LMK if you think I should change it back or if it's okay as is now.

Copy link
Member

@cameel cameel left a comment

Choose a reason for hiding this comment

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

Note that CI is failing (it's the spellcheck job - you have a spelling mistake somewhere in there).

Other than that it looks good. I haven't reviewed this in detail, but it's been sitting there for a long time and it would be nice to finally get this merged.

docs/resources.rst Outdated Show resolved Hide resolved
@cameel
Copy link
Member

cameel commented Nov 26, 2024

BTW, you could list all the other redundant PRs in your description and github will automatically close them when we merge this one. That would make it easier to keep track of them, because we have quite a few now.

To do this write something like Closes #xyz. Just note that it has to be in the description at the top (not in a random comment) and you have to repeat Closes for each one (so no shortcuts like Closes #xyz, #abc, #def).

@ethereum ethereum deleted a comment from github-actions bot Nov 26, 2024
@ethereum ethereum deleted a comment from github-actions bot Nov 26, 2024
@ethereum ethereum deleted a comment from github-actions bot Nov 26, 2024
@ethereum ethereum deleted a comment from github-actions bot Nov 26, 2024
@ethereum ethereum deleted a comment from github-actions bot Nov 26, 2024
@mehtavishwa30 mehtavishwa30 requested a review from cameel November 27, 2024 10:23
@cameel cameel force-pushed the mehtavishwa30-patch-1 branch from f6290b4 to 3bba192 Compare November 28, 2024 17:33
Copy link
Member

@cameel cameel left a comment

Choose a reason for hiding this comment

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

Looks good to me, but needs some commit squashing. I guess we could just squash-merge?

@cameel cameel enabled auto-merge (squash) November 28, 2024 17:37
@cameel cameel merged commit 1cce974 into develop Nov 28, 2024
73 checks passed
@cameel cameel deleted the mehtavishwa30-patch-1 branch November 28, 2024 18:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants