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

issue #20654 #80643

Closed
wants to merge 1 commit into from
Closed

issue #20654 #80643

wants to merge 1 commit into from

Conversation

Ankush1oo8
Copy link

Resolve issue #20654 and made a documentaion for flash simulator
if ihave made any mistakes please feel free to correct me

Copy link

Hello @Ankush1oo8, and thank you very much for your first pull request to the Zephyr project!
Our Continuous Integration pipeline will execute a series of checks on your Pull Request commit messages and code, and you are expected to address any failures by updating the PR. Please take a look at our commit message guidelines to find out how to format your commit messages, and at our contribution workflow to understand how to update your Pull Request. If you haven't already, please make sure to review the project's Contributor Expectations and update (by amending and force-pushing the commits) your pull request if necessary.
If you are stuck or need help please join us on Discord and ask your question there. Additionally, you can escalate the review when applicable. 😊

@nashif
Copy link
Member

nashif commented Oct 30, 2024

please use a more descpretive title

@Ankush1oo8
Copy link
Author

Like how
What is Flash simulator?

@Ankush1oo8
Copy link
Author

if possible can you edit

please use a more descpretive title

Cann you help with that please
if posible can you change it

@dcpleung dcpleung removed their request for review October 30, 2024 17:29
Copy link
Collaborator

@thedjnK thedjnK left a comment

Choose a reason for hiding this comment

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

Some questions:

  • How much of this did you personally write yourself?
  • How familiar are you with the flash simulator driver?
  • How accurate is the text in the PR?

@Ankush1oo8
Copy link
Author

Some questions:

  • How much of this did you personally write yourself?
  • How familiar are you with the flash simulator driver?
  • How accurate is the text in the PR?

Actually I am linux user and often in my college project i use the it for testing pupose
The text about is wrten by me and i have taken help of ai in some sections

@kartben
Copy link
Collaborator

kartben commented Oct 30, 2024

Hi @Ankush1oo8

Thanks very much for the PR -- it is always nice to see people trying to help tackle some of the issues that have been open for a very long time. However, in this particular situation, I don't think just asking ChatGPT to document flash_simulator.c is getting us to the level of detail that is really helpful for someone to really learn about the capabilities of the simulator.

As a thought, you may want to consider writing a new code sample that exercises zephyr,sim-flash and helps users understand some of the key features such as statistics collection, etc.

Would you be interested in doing that?

In any case you may want to have a look at our contribution guidelines and documentation writing guidelines (for example, the page you're proposing to add is not even "mounted" in the documentation's table of contents at the moment)

Thanks!

Copy link
Member

@gmarull gmarull left a comment

Choose a reason for hiding this comment

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

No AI garbage please.

@Ankush1oo8 Ankush1oo8 closed this Oct 30, 2024
@kartben
Copy link
Collaborator

kartben commented Oct 30, 2024

@Ankush1oo8 so I take it that you are not interested in iterating on this and possibly contributing a code sample (or an improved doc page?)

@Ankush1oo8
Copy link
Author

I want to contribute but i dont know how can i do that

@kartben
Copy link
Collaborator

kartben commented Oct 30, 2024

I want to contribute but i dont know how can i do that

I think I gave you some pointers/ideas above but let me know if you have specific questions

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants