Enhance Documentation & Development Experience #41
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…n and add initial CONTRIBUTING.md file
…o include CNCF in dictionary
DhairyaMajmudar
suggested changes
May 8, 2024
.vscode/settings.json
Outdated
| @@ -0,0 +1,3 @@ | |||
| { | |||
There was a problem hiding this comment.
Hi @Michael-Obele
any specific reason for this file change ?
There was a problem hiding this comment.
This was supposed to be an internal setting for my VSCode; I will remove it.
|
|
||
| * [**Reporting Bugs** 🐞](#reporting-bugs-🐞) | ||
| * [**Suggesting Features** 💡](#suggesting-features-💡) | ||
| * [**Improving the Website** 🌐](#improving-the-website-🌐) |
There was a problem hiding this comment.
Here how's about adding one more section related to docs improvement.
There was a problem hiding this comment.
Okay, I will do just that. Thanks
|
Hello @Michael-Obele left some changes, pls. once have a look on them : ) |
Hi @DhairyaMajmudar, Sure thing. I just made some changes; if you have time, please take a look and let me know if there is anything else I should change. |
DhairyaMajmudar
approved these changes
May 9, 2024
aialok
reviewed
May 9, 2024
Fix for data name change Co-authored-by: Alok Gupta <alokgupta1560@gmail.com>
aialok
approved these changes
May 13, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Information
What kind of change does this PR introduce?
Documentation improvements and developer experience enhancements.
Issue Number:
*Closes #14: Project documentation on GitHub. This pull request introduces a CONTRIBUTING guide as requested in issue #14.
Screenshots/videos:
N/A (This pull request focuses on documentation and configuration changes.)
If relevant, did you update the documentation?
Yes, this pull request introduces a new
CONTRIBUTING.mdfile and updates theREADME.mdfile.Summary
This pull request improves the project's documentation and development experience in several ways:
README.mdto offer a more thorough introduction to the project and simplifies local development setup.These changes aim to empower contributors, improve project understanding, and streamline development workflows.
Does this PR introduce a breaking change?
No, this pull request does not introduce any breaking changes.