Skip to content

docs: expand README with comprehensive project information#201

Merged
hami-robot[bot] merged 1 commit intoProject-HAMi:masterfrom
mesutoezdil:docs/improve-readme
Apr 28, 2026
Merged

docs: expand README with comprehensive project information#201
hami-robot[bot] merged 1 commit intoProject-HAMi:masterfrom
mesutoezdil:docs/improve-readme

Conversation

@mesutoezdil
Copy link
Copy Markdown
Contributor

@mesutoezdil mesutoezdil commented Apr 23, 2026

The original README was minimal (40 lines) with only basic npm commands. Insufficient information for:

  • New contributors understanding project structure
  • Users seeking documentation guidance
  • Developers needing build/deployment information

My Changes: Expanded README with 14+ new sections including:

  • Project overview - What HAMi is and links to main repo
  • Project structure - Clear directory organization
  • Performance details - Build optimization information
  • Multi-language support - Info about English/Chinese docs
  • Contributing guidelines - Contribution workflow and DCO requirements
  • Build scripts reference - Complete command reference table
  • Technology stack - Dependencies and versions
  • Related resources - Links to issues, discussions, main repo

@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 23, 2026

Deploy Preview for project-hami ready!

Name Link
🔨 Latest commit 593a595
🔍 Latest deploy log https://app.netlify.com/projects/project-hami/deploys/69ef0806a5391600080421dd
😎 Deploy Preview https://deploy-preview-201--project-hami.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@hami-robot hami-robot Bot added the size/L label Apr 23, 2026
Comment thread README.md Outdated

---

**Last Updated**: April 2026
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we need a update timestamp here.

@rootsongjc
Copy link
Copy Markdown
Contributor

Great improvement overall — the README is much more complete and professional now. One suggestion: it may be slightly too verbose in some sections, with a few repeated items (for example project links, repository references, contribution guidance, and related resources).

I’d recommend tightening and consolidating overlapping sections so readers can reach the core value proposition faster. A shorter, sharper README often works better for first-time visitors, while detailed information can be moved into dedicated docs pages.

@mesutoezdil
Copy link
Copy Markdown
Contributor Author

@rootsongjc You're right about the timestamp - not necessary for a README. I'll remove that.

Regarding the verbosity feedback: excellent point. I'll consolidate the overlapping sections (project links, repository references, contribution guidance, and related resources) into more focused, non-redundant sections. The goal should be getting readers to the core information faster, with detailed content properly linked to dedicated docs pages. I'll revise and push the updated version shortly.

@mesutoezdil
Copy link
Copy Markdown
Contributor Author

mesutoezdil commented Apr 23, 2026

Changes implemented:

  • Removed the timestamp - No longer needed in README
  • Consolidated overlapping sections - Merged Website/Issues/Discussions/Related Resources into a single concise 'Links' section
  • Eliminated duplication - Removed duplicate references (Main Repository, Project Website, etc.)
  • Streamlined structure - README now flows better with core info readily accessible, detailed guidance preserved in dedicated docs

The README is now more focused while maintaining all essential information and links. Ready for re-review.

Copy link
Copy Markdown
Contributor

@rootsongjc rootsongjc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@windsonsea
Copy link
Copy Markdown
Member

/lgtm

@windsonsea
Copy link
Copy Markdown
Member

/approve

@hami-robot
Copy link
Copy Markdown
Contributor

hami-robot Bot commented Apr 27, 2026

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mesutoezdil, rootsongjc, windsonsea

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@hami-robot hami-robot Bot added the approved label Apr 27, 2026
…and links

Signed-off-by: mesutoezdil <mesudozdil@gmail.com>
@mesutoezdil mesutoezdil force-pushed the docs/improve-readme branch from 9012935 to 593a595 Compare April 27, 2026 06:53
@hami-robot hami-robot Bot removed the lgtm label Apr 27, 2026
@windsonsea
Copy link
Copy Markdown
Member

/lgtm

@hami-robot hami-robot Bot added the lgtm label Apr 28, 2026
@hami-robot hami-robot Bot merged commit 91f547e into Project-HAMi:master Apr 28, 2026
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants