Skip to content

Conversation

@vmeetx
Copy link
Contributor

@vmeetx vmeetx commented Sep 30, 2025

Summary

This PR proofreads and fixes grammatical errors in the Sugar Labs dev_guide for clarity and readability.

Related Issue:

Changes Introduced:

  • Fixed commas, semicolons, and spacing
  • Polished wording while keeping all italic and bold formatting
  • Verified technical instructions remain accurate

Notes:

  • Markdown renders correctly; all links work
  • No code or build changes
  • While editing, noticed duplicate npm run build instructions— comment added to PR for clarification.

@github-actions
Copy link

❌ Checks Failed

Status: 🚫 Not ready to merge

Please fix the following issues before merging:

📝 Code Linting Failed

Issue: Code formatting or style violations detected.

Specific problems:

• Markdown linting failed

How to fix:

Platform Command Description
🐧 Unix/macOS/Linux npm run format Auto-fix all formatting issues
🪟 Windows npm run format:file <filename> Fix specific files
🔍 Check Only npm run format:check Check formatting without fixing

Need help with linting? Check out the Linting Guide for Windows Users for detailed instructions.


🛠️ Next Steps

  1. Fix the issues mentioned above
  2. Test locally to ensure everything works
  3. Push your fixes to this branch
  4. Wait for re-check - This bot will automatically run again

🤖 This comment will be updated automatically when you push new commits

@vmeetx
Copy link
Contributor Author

vmeetx commented Sep 30, 2025

Hi!
In the original guide, I noticed 'npm run build' is listed twice for a generic build and for /www-v2.
I checked vite.config.ts and it seemed to me like both do the same. Is there any functional difference between them?

Fix linting issue
@github-actions
Copy link

❌ Checks Failed

Status: 🚫 Not ready to merge

Please fix the following issues before merging:

📝 Code Linting Failed

Issue: Code formatting or style violations detected.

Specific problems:

• Markdown linting failed

How to fix:

Platform Command Description
🐧 Unix/macOS/Linux npm run format Auto-fix all formatting issues
🪟 Windows npm run format:file <filename> Fix specific files
🔍 Check Only npm run format:check Check formatting without fixing

Need help with linting? Check out the Linting Guide for Windows Users for detailed instructions.


🛠️ Next Steps

  1. Fix the issues mentioned above
  2. Test locally to ensure everything works
  3. Push your fixes to this branch
  4. Wait for re-check - This bot will automatically run again

🤖 This comment will be updated automatically when you push new commits

@github-actions
Copy link

🎉 All Checks Passed!

Status: ✅ Ready to merge

✅ Completed Workflows

Workflow Status Details
🔨 Continuous Integration ✅ Passed Build completed successfully
📝 Code Linting ✅ Passed All formatting and style checks passed

🚀 This PR is ready for review and can be safely merged to main branch!

Great work! Your code meets all quality standards. 👏

@sa-fw-an
Copy link
Member

sa-fw-an commented Oct 1, 2025

Good work @vmeetx :)

@sa-fw-an sa-fw-an merged commit ff7d087 into sugarlabs:main Oct 1, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants