docs(CONTRIBUTING): correct paths, cleaned commands,remove prompts, and fix diff examples.#47311
Closed
nandhakumar1980 wants to merge 1 commit intomui:masterfrom
Closed
docs(CONTRIBUTING): correct paths, cleaned commands,remove prompts, and fix diff examples.#47311nandhakumar1980 wants to merge 1 commit intomui:masterfrom
nandhakumar1980 wants to merge 1 commit intomui:masterfrom
Conversation
Updated commands and file references in CONTRIBUTING.md. This update cleans and corrects multiple issues in the CONTRIBUTING.md file. Key changes: - Removed leftover HTML comment (`<!-- #target-branch-reference -->`) - Fixed incorrect diff headers (`a//package.json` → `a/package.json`) - Corrected example demo paths for clarity - Removed shell prompt symbols ($, $>) from code blocks for consistency - Normalized Windows-style prompt lines to plain command examples - Improved clarity for example shell commands - Updated references from 'master' to 'main' (only if the repository uses main) - Converted superscript-style link references to standard markdown links - Ensured consistent formatting across code snippets and examples These updates improve readability, ensure examples are copy-paste friendly, and maintain consistency across documentation. Signed-off-by: nandhakumar1980 <nandhakumar.p.s.139@kalvium.community>
Netlify deploy previewhttps://deploy-preview-47311--material-ui.netlify.app/ Bundle size report
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
This pull request improves the clarity, accuracy, and consistency of the CONTRIBUTING.md file.
✔️ What was updated
Removed a leftover HTML comment that wasn’t needed.
Corrected an invalid diff header (a//package.json → a/package.json).
Fixed incorrect or confusing demo paths in documentation examples.
Removed shell prompt symbols ($, $ >) from code blocks to ensure commands can be copy-pasted directly.
Normalized Windows-style command prompts to plain, consistent examples.
Updated references from master to main (if applicable to repo).
Improved markdown link usage by replacing superscript-style references.
Cleaned and standardized formatting across examples and code sections.
🎯 Why this is needed
These changes:
Improve documentation accuracy
Make command examples usable without modification
Provide consistent formatting throughout
Reduce confusion for new contributors
📌 Additional Notes
All changes are documentation-only and do not affect any runtime code.