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

Update README #1186

Closed
ClaudiaComito opened this issue Jul 31, 2023 · 6 comments
Closed

Update README #1186

ClaudiaComito opened this issue Jul 31, 2023 · 6 comments
Assignees
@ClaudiaComito
Labels
documentation Anything related to documentation stale

Comments

@ClaudiaComito
Copy link
Contributor

ClaudiaComito commented Jul 31, 2023 •
edited by mrfh92
Loading

Feature functionality
I propose to update the README description of Heat to:

  • (urgent) contain less blurb, more examples/illustrations
  • (optional) point to a handful of high-priority Good First Issues for new users
  • (from closed Documentation - add 'Hello World' page #612:) hello world example or link to a hello work example, if the examples so far are considered as not sufficient
  • more TBD
@ClaudiaComito ClaudiaComito added the documentation Anything related to documentation label Jul 31, 2023
@ClaudiaComito ClaudiaComito added this to the Repo Clean-Up milestone Jul 31, 2023
@ClaudiaComito ClaudiaComito mentioned this issue Jul 31, 2023
Open
@Sai-Suraj-27
Copy link
Collaborator

@ClaudiaComito mam, I think it would be nice if we remove Resources section and shorten the Contribution guidelines section since there is already a contributing.md file and replace them with more examples and Good First issues.

@ClaudiaComito ClaudiaComito self-assigned this Aug 7, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Aug 7, 2023

Branch docs/1186-Update_README created!

This was referenced Aug 7, 2023
Merged
Closed
@ClaudiaComito ClaudiaComito mentioned this issue Aug 15, 2023
Merged
5 tasks
@mrfh92 mrfh92 mentioned this issue Aug 21, 2023
Closed
@mrfh92
Copy link
Collaborator

mrfh92 commented Aug 21, 2023

Added comment regarding "hello world example" from closed #612
Stil ongoing work and useful.

Reviewed within #1109

@mrfh92 mrfh92 removed this from the Repo Clean-Up milestone Aug 21, 2023
@ClaudiaComito ClaudiaComito mentioned this issue Sep 29, 2023
Closed
@mrfh92 mrfh92 mentioned this issue Oct 5, 2023
Closed
@github-actions
Copy link
Contributor

github-actions bot commented Oct 9, 2023

Branch docs/1186-Update_README created!

@ClaudiaComito ClaudiaComito mentioned this issue Oct 13, 2023
Open
@ClaudiaComito ClaudiaComito mentioned this issue Oct 23, 2023
Closed
@github-actions GitHub Actions
Copy link
Contributor

This issue is stale because it has been open for 60 days with no activity.

@github-actions github-actions bot added the stale label Dec 11, 2023
@github-actions GitHub Actions
Copy link
Contributor

This issue was closed because it has been inactive for 60 days since being marked as stale.

@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Feb 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ClaudiaComito ClaudiaComito

Labels
documentation Anything related to documentation stale
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@ClaudiaComito @Sai-Suraj-27 @mrfh92