-
Notifications
You must be signed in to change notification settings - Fork 41
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
[WIP] Revamp standard docs, remove README contribution notes #87
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bump docs dependencies, add readthedocs requirements
* new issue and pr templates
* convert bash scripts to py
* bump versions in dependencies and ci builds * move tox to [dev] per issue ethereum#34 * move RTD deps pointer into .readthedocs.yml * unpin flake8 add flake8-bugbear to lint deps
* remove gitter, testing setup, and pandoc sections, add quotes to dev install
* repin flake8, bump tox to >=4.0.0 as that's where whitelist was deprecated, misc updates
* template cleanup following initial merge with py-evm * add flake8 pin comment * correct license years * add pin note to mypy
…m#81) * apply template updates found following merge with eth-typing * add build as a dev dependency * remove timeout from pytest.ini, it doesn't do anything without pytest-timeout as a dep
* add updates found when merging template with py-ssz and eth-abi * add wheel and wheel-windows to ci and reorg
pacrob
force-pushed
the
move-readme-dev-info-to-docs
branch
4 times, most recently
from
April 25, 2023 23:01
274b304
to
2df66bc
Compare
pacrob
force-pushed
the
move-readme-dev-info-to-docs
branch
6 times, most recently
from
April 27, 2023 14:44
dfe9148
to
b1fd0de
Compare
… tend to be installed on a user machine
pacrob
force-pushed
the
move-readme-dev-info-to-docs
branch
from
April 27, 2023 17:16
b1fd0de
to
2cccf7f
Compare
pacrob
changed the title
remove README contribution notes, add bits to contributing docs
[WIP] Revamp standard docs, remove README contribution notes
Apr 27, 2023
As you're thinking about standardizing contributing docs, I was thinking it might be good to document the |
Many libs actually don't have docs, so also have a pattern with contribution info still in the README |
closed by #134 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What was wrong?
Documentation across snakecharmer libraries is very varied.
Some good examples:
py-evm
andweb3
: Introduction, Quickstart, Community, and Code of Conducteth-abi
at least has a Welcome pageMost of the others are relatively light, if not just auto-generated or nothing at all.
This PR will collect removing stuff from the README and moving things into standardized sections of docs.
note for later - .rst code blocks can have
copyable
set to make it easier to copypasta for usersCloses #78
Cute Animal Picture