-
Notifications
You must be signed in to change notification settings - Fork 88
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: create suggestions for book improvement #263
base: dev
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would say it's not bad but don't create a new md file for the changes, either:
- Directly apply the change in the PR and comment the change on github directly
- First propose the change on github and we can discuss it
And if you use AI tools please be sure to verify by yourself all the suggestions as well!
@julio4, thank you for your input could you kindly confirm if the approach I used in the last two PRs aligns with your recommendation to make and comment the changes directly here? Commit 53800b5: Fixed the broken contribute link across multiple pages in the book. It previously pointed to a 404 page, but I changed it to point to the CONTRIBUTING.md file. Commit 9ca6616: Fixed another broken link. Does this approach align with your suggestion in your previous comment?
|
I'm proposing a suggestion to enhance the user experience for first-time users of this book. Since the main contract code, interfaces, and tests are stored in listings, while the main contract and interface definitions might not be immediately visible to users unfamiliar with the book's structure, I suggest adding a link tag to the location of the visible code in the listings. Example:Specifically, I propose modifying the current implementation: Current:
Suggested:
This change would provide easier access to the full contract code for users who want to explore the implementation and interface definitions. Additionally, I suggest introducing this approach throughout the book wherever necessary. For example, we could add similar links at the beginning of each chapter or section that includes listings, providing easy access to the complete source code. |
Issue: Close #259
Description
The changes here is just a draft PR to find out from the maintainers if my implementation is inline with the project description