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 Clean #1327

Merged
Merged

Conversation

boundless-forest
Copy link
Collaborator

@boundless-forest boundless-forest commented Mar 4, 2024

This PR reconstructs the document in this repo, many of them are out of date. Some of the utils, examples are created at least 3 years ago and untouched afterwards, seems unnecessary today. Also, the frontier tempate node release is already archived, I think there is no need to keep this. Make the document layout much clearer, then we can consider adding more in the future. @sorpaas

frame/evm/src/weights.rs Outdated Show resolved Hide resolved
docs/pallet-ethereum.md Outdated Show resolved Hide resolved
docs/package.json Outdated Show resolved Hide resolved
frame/evm/src/weights.rs Outdated Show resolved Hide resolved
@boundless-forest
Copy link
Collaborator Author

@koushiro @sorpaas Please review this again.

This was referenced Apr 3, 2024
Copy link
Collaborator

@koushiro koushiro left a comment

Choose a reason for hiding this comment

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

Please unify the doc format, such as the length of each line in the markdown
revert the changes or using new style
maybe check them with editorconfig?

@boundless-forest
Copy link
Collaborator Author

boundless-forest commented Apr 3, 2024

Please unify the doc format, such as the length of each line in the markdown

Do you have a recommended way to limit the line length in the markdown? I have tried the editorconfig, it doesn't have this option yet. I don't think it's a good idea to use some personal plugin, extensions that are not friendly to different development enviroment.

@koushiro
Copy link
Collaborator

koushiro commented Apr 3, 2024

I mean using editorconfig CI to check the max line length editorconfig/editorconfig#387
If you think it's not a good idea, then at least manually maintain a consistent formatting style in this PR

@boundless-forest boundless-forest merged commit 8f09272 into polkadot-evm:master Apr 3, 2024
4 checks passed
@cdxker
Copy link

cdxker commented Apr 3, 2024

Cheers. Thanks for this pr!

@boundless-forest boundless-forest deleted the bear-clean-docs branch April 3, 2024 07:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants