Feat: Book Proofread

[julio4]

Description

In this issue, we need thorough proofreading of the Starknet By Example book to identify significant issues that could affect developer understanding. The goal is to maintain a high-quality, accurate documentation that reflects current best practices and correct implementation details.

What to Look For

• Logic inaccuracies or outdated information
• Mismatched explanations
• Deprecated/outdated features or syntax
• Inconsistencies between different sections
• Missing critical information or incomplete explanations
• Logic errors in explanations or implementations

Review Process and Criterias

1. Read through the documentation with care
2. Document any significant issue found, including:
   • The specific location (URL/section/line number)
   • Current content/context
   • Why it's problematic
   • Suggested correction or improvement
3. If the issue require substantial changes you can also open a separate issue (with a link to this issue)
4. Group any related issues if they have the same root cause

ODHack

To be eligible for additional rewards, be sure to review and follow the ODHack Common Guidelines and Contributing Guidelines.

Be sure to join the telegram group and introduce yourself.

[od-hunter]

Hi @julio4 , can I work on this please? I'm also good at documentations. Below are some of the documentations I've done that were merged: https://github.com/dojoengine/book/pull/308, https://github.com/keep-starknet-strange/joyboy/pull/143, https://github.com/Scaffold-Stark/ss2-docs/pull/31, https://github.com/horuslabsio/Starknet-Scaffold/pull/94, https://github.com/Hyle-org/examples/pull/15. For this issue, after cloning the repository, I'll focus on Logic Errors (Incorrect or outdated code examples), Consistency (Mismatched terminology or formatting across sections), Completeness (Missing explanations or incomplete implementation steps), Deprecation (References to outdated or unsupported features). Then, I'll describe the logic or content problem. I'll provide corrected explanations or updated code. I'll test examples locally using CLI tools, then document errors or deviations in outputs. I'll use markdownlint to check syntax and format. KIndly assign me please.

ETA: 54 hours.

[akintewe]

Hi, I'm akintewe and i would love to work on this issue I My ETA is > 24hrs to complete.

I have experience in Cairo, javascript and also alittle solidity, which would help me with this issue. I would make sure i document any issues found, make sure everything is precise and accurate.

I am very good with documentation too.

I am a new contributor, happy to help :)

[NueloSE]

Can I work on this, please?

[vestor-dev]

Is it okay if I take this? please kindly assign

[Supa-mega]

May I take this issue on?

[ShantelPeters]

Can I try solving this issue?

[sandragcarrillo]

Hi, I would love to contribute to this issue. As I have been learning Cairo for the past 3 months, I have been using Starknet by example and finding some issues such as deprecated features and missing explanations. I would love to take that experience and make it a contribution solving this issue.

[julio4]

Assigned mainly @od-hunter BUT everyone can still contribute directly here without having to be assigned. For any finding I'll create a separate issue and assign someone to it.

[od-hunter]

Assigned mainly @od-hunter BUT everyone can still contribute directly here without having to be assigned. For any finding I'll create a separate issue and assign someone to it.

Will get to it🫡