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.

Sign up for GitHub

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

Jump to bottom

Documentation #33

Open
MelbourneDeveloper opened this issue Sep 24, 2024 · 2 comments
Open

Documentation #33

MelbourneDeveloper opened this issue Sep 24, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers high priority

Comments

@MelbourneDeveloper
Copy link
Collaborator

Add documentation to all the public elements in both libraries.

AI makes this easy. Just follow these guidelines:

  • Give the AI examples of the existing doco so it can follow the style
  • Tell the AI that this is part of charts_flutter because most of them know the library well
  • Tell the AI to fill in missing documentation, but not modify existing documentation
  • Include all of the code in the context so it's more accurate
  • Claude Sonnet or Opus are great models. The newer ChatGPT models are also pretty good

Keep it consistent and check for errors.

You don't have to do it all at once. Just a few files at time would be help.
@MelbourneDeveloper MelbourneDeveloper added good first issue Good for newcomers documentation Improvements or additions to documentation high priority labels Sep 24, 2024
sanarawal7 added a commit to sanarawal7/nimble_charts that referenced this issue Oct 6, 2024
@sanarawal7
Update cartesian_chart.dart
10e5cd9 
Nimblesite#33 please let me know if this is how you wanted the documentation.
@sanarawal7 sanarawal7 mentioned this issue Oct 6, 2024
Closed
@venbrinoDev
Copy link

Great will help on this and other place i can contribute

Thanks for this

@venbrinoDev
Copy link

There is also a lot of linter warning would also try to look at that

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers high priority
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@MelbourneDeveloper @venbrinoDev