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

Added Smart contract design and UX Doc #13832

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

harshitdabra
Copy link

This PR is for the new documentation of "Smart contract design and UX". New content is added and is required to be merged.

fixes #13656

@github-actions github-actions bot added the content 🖋️ This involves copy additions or edits label Sep 9, 2024
Copy link

netlify bot commented Sep 9, 2024

Deploy Preview for ethereumorg ready!

Name Link
🔨 Latest commit 7c96b83
🔍 Latest deploy log https://app.netlify.com/sites/ethereumorg/deploys/66ded97f27514d00086d7071
😎 Deploy Preview https://deploy-preview-13832--ethereumorg.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
7 paths audited
Performance: 37 (🔴 down 11 from production)
Accessibility: 92 (🔴 down 1 from production)
Best Practices: 87 (🔴 down 5 from production)
SEO: 92 (🔴 down 1 from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@konopkja
Copy link
Contributor

konopkja commented Sep 9, 2024

Hi @harshitdabra, was this generated by AI?

Using AI isn’t an issue as long as it’s done thoughtfully, but the draft could benefit from some editing to improve clarity and flow.

  1. There are excessive sentences and paragraphs that don’t add much value and should be trimmed.
  2. The first two sections can likely be removed to create a smoother structure.
  3. Some topics feel too broad, and more detailed, practical insights would be helpful.

There are good starting points, but the overall length is a bit much, and the quality could be refined.

@harshitdabra
Copy link
Author

Only 2-3 snippets were AI generated but overall tried to align in as per requirements. Will update another version shortly as per your review @konopkja

@konopkja
Copy link
Contributor

konopkja commented Sep 9, 2024

Only 2-3 snippets were AI generated but overall tried to align in as per requirements. Will update another version shortly as per your review @konopkja

Ok, thank you. Happy to provide more in depth review and comments on the next version and get this ready to be published.

Also a side note, this should not replace content on "developers/docs/design-and-ux/" , rather it should be a new subpage in this section.

For example "developers/docs/design-and-ux/smart-contract-ux"

@corwintines
Copy link
Member

@harshitdabra closed the new PR you opened for changes to this PR. Please keep any changes within this pull request so we have context of previous discussion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content 🖋️ This involves copy additions or edits
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Content request: Smart contract design and UX
3 participants