docs: consolidate README prerequisites and reorder intro sections#75
docs: consolidate README prerequisites and reorder intro sections#75MEECHAIN1 wants to merge 2 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughPR Review: README Documentation UpdateWalkthroughThis PR enhances the README with clarification on the required server setup and a comprehensive project structure overview. It documents that ChangesDocumentation Enhancement
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
PR Review: README Documentation Update (ไทย)Walkthrough (สรุปข้อมูลย่อ)PR นี้ปรับปรุง README ด้วยการชี้แจงเกี่ยวกับการตั้งค่าเซิร์ฟเวอร์ที่จำเป็นและภาพรวมโครงสร้างโครงการที่ครอบคลุม เอกสารระบุว่าต้องใช้ Changes (การเปลี่ยนแปลง)Documentation Enhancement (การปรับปรุงเอกสาร)
Estimated code review effort (ประมาณความพยายามในการตรวจสอบ)🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs (PR ที่อาจเกี่ยวข้อง)
Poem (บทกวี)
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Review rate limit: 0/1 reviews remaining, refill in 60 minutes.Comment |
|
🚅 Deployed to the MeeChain-Connect-pr-75 environment in meechain 5 services not affected by this PR
|
Deploying with
|
| Status | Name | Latest Commit | Updated (UTC) |
|---|---|---|---|
| ❌ Deployment failed View logs |
meechain-connect | 6826c98 | May 04 2026, 04:16 AM |
…eadme Signed-off-by: ธณวัฒน์ ประวันตา <pouaun2499@gmail.com>
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 6826c98d3b
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| └── test/ # Test files | ||
| ## 🚀 Deployment Guide |
There was a problem hiding this comment.
The new ## Project Structure snippet opens a fenced code block with ``` but never closes it, so Markdown renderers treat the rest of the README (starting at ## 🚀 Deployment Guide) as code instead of headings/content. This breaks document structure and navigation for all downstream sections until EOF.
Useful? React with 👍 / 👎.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
12-12:⚠️ Potential issue | 🟠 Major | ⚖️ Poor tradeoffแก้ไขความไม่สอดคล้องระหว่าง Prerequisites และ Usage note / Fix inconsistency between Prerequisites and Usage note
ข้อความใน Prerequisites บอกว่า static server (
python3 -m http.server,npx serve) เป็นตัวเลือกที่ใช้ได้ แต่ Usage note (บรรทัด 28-29) ระบุชัดเจนว่าต้องใช้node server.jsเท่านั้นเพื่อให้/api/*และ/rpc/*ทำงานได้ ซึ่งขัดแย้งกันThe Prerequisites line suggests that static servers (
python3 -m http.server,npx serve) are valid alternatives, but the Usage note (lines 28-29) clearly states that onlynode server.jsworks for full API support. This is contradictory and misleading.🔧 การแก้ไขที่แนะนำ / Proposed fix
-- Local web server (`python3 -m http.server`, `npx serve`) หรือรันผ่าน `node server.js` +- Local web server: **ต้องรันผ่าน `node server.js`** เพื่อให้ `/api/*` และ `/rpc/*` ทำงานได้ครบถ้วนหรือถ้าต้องการเก็บข้อมูลเดิมไว้ / Or to preserve the original information:
-- Local web server (`python3 -m http.server`, `npx serve`) หรือรันผ่าน `node server.js` +- Local web server: `node server.js` (required for `/api/*` and `/rpc/*` support) + - หมายเหตุ: `python3 -m http.server` และ `npx serve` ใช้เสิร์ฟไฟล์ static ได้เท่านั้น🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 12, Update the README to resolve the contradiction: change the Prerequisites line that lists "Local web server (`python3 -m http.server`, `npx serve`) หรือรันผ่าน `node server.js`" so it clearly states that a simple static server (python3/npx serve) will only serve static assets and that full API routes (/api/* and /rpc/*) require running the Node server (run `node server.js`); alternatively, if you intend static servers to be supported, modify the Usage note where it mandates `node server.js` (lines describing /api/* and /rpc/*) to explain how to proxy or enable those routes when using a static server—ensure the README text references the Prerequisites sentence and the Usage note about /api/* and /rpc/* so the behaviour is unambiguous.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 31-48: Remove the duplicate "## Project Structure" section by
keeping the first occurrence (the simpler block under the initial "## Project
Structure" header) and merging in the missing entries from the second block: add
server.js, worker.js, clarify scripts/ entries, change js/ to "Front-end
JavaScript modules", and consolidate tests into "test/ (Unit/integration tests)"
plus "tests/ (Additional test suites)" as shown in the suggested consolidation;
then delete the entire second "## Project Structure" block so only the
consolidated single section remains.
- Line 32: The fenced code block in the README containing the directory tree
snippet (the block with "├── index.html" and "├── explorer.html") lacks a
language identifier; update that fenced block to include a language (e.g., use
```text) so the block becomes ```text … ``` to satisfy markdownlint MD040 and
improve rendering consistency.
---
Outside diff comments:
In `@README.md`:
- Line 12: Update the README to resolve the contradiction: change the
Prerequisites line that lists "Local web server (`python3 -m http.server`, `npx
serve`) หรือรันผ่าน `node server.js`" so it clearly states that a simple static
server (python3/npx serve) will only serve static assets and that full API
routes (/api/* and /rpc/*) require running the Node server (run `node
server.js`); alternatively, if you intend static servers to be supported, modify
the Usage note where it mandates `node server.js` (lines describing /api/* and
/rpc/*) to explain how to proxy or enable those routes when using a static
server—ensure the README text references the Prerequisites sentence and the
Usage note about /api/* and /rpc/* so the behaviour is unambiguous.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| ## Project Structure | ||
| ``` | ||
| ├── index.html # Main dashboard page | ||
| ├── explorer.html # Mee Ritual Chain Explorer | ||
| ├── dao.html # Governance / DAO dashboard | ||
| ├── analytics.html # Analytics dashboard | ||
| ├── nft-market.html # NFT Marketplace | ||
| ├── scripts/ | ||
| │ ├── start.sh # Service start helper | ||
| │ ├── stop.sh # Service stop helper | ||
| │ └── rpc-check.sh # RPC ritual health check | ||
| ├── src/ | ||
| │ ├── css/ # Stylesheets | ||
| │ ├── js/ # JavaScript files | ||
| │ └── assets/ # Images and resources | ||
| ├── contracts/ # Smart contracts | ||
| ├── functions/ # Serverless API functions | ||
| └── test/ # Test files |
There was a problem hiding this comment.
พบ Project Structure ซ้ำสองครั้ง / Duplicate Project Structure sections found
มีหัวข้อ "## Project Structure" ปรากฏสองครั้งในไฟล์:
- บรรทัด 31-48: เวอร์ชันแรก (ง่ายกว่า)
- บรรทัด 354-374: เวอร์ชันที่สอง (มีรายละเอียดเพิ่ม เช่น
server.js,worker.js,scripts/ซ้ำ)
ตาม PR objectives ระบุว่า "Removed duplicate/extra Project Structure placement" แต่ยังคงมีทั้งสองเวอร์ชันอยู่
Two "## Project Structure" sections appear in the file:
- Lines 31-48: First version (simpler)
- Lines 354-374: Second version (more detailed, includes
server.js,worker.js, duplicatescripts/)
According to PR objectives, "Removed duplicate/extra Project Structure placement" but both versions still exist.
คำแนะนำ / Recommendation:
รวมทั้งสองเวอร์ชันเป็นเวอร์ชันเดียวที่บรรทัด 31-48 (ตามลำดับที่ PR ต้องการ: Prerequisites -> Installation -> Usage -> Project Structure) และลบเวอร์ชันที่บรรทัด 354-374
Consolidate both versions into a single comprehensive version at lines 31-48 (following the PR's desired order: Prerequisites -> Installation -> Usage -> Project Structure) and remove the version at lines 354-374.
♻️ ข้อเสนอแนะสำหรับการรวม / Suggested consolidation
เก็บเวอร์ชันที่บรรทัด 31-48 แล้วเพิ่มรายละเอียดที่ขาดหายไป:
Keep the version at lines 31-48 and add missing details:
## Project Structure
-```
+```text
├── index.html # Main dashboard page
├── explorer.html # Mee Ritual Chain Explorer
├── dao.html # Governance / DAO dashboard
├── analytics.html # Analytics dashboard
├── nft-market.html # NFT Marketplace
+├── server.js # Local API/server entrypoint
+├── worker.js # Cloudflare Worker entrypoint
├── scripts/
-│ ├── start.sh # Service start helper
-│ ├── stop.sh # Service stop helper
-│ └── rpc-check.sh # RPC ritual health check
+│ ├── start.sh # Service start helper
+│ ├── stop.sh # Service stop helper
+│ └── rpc-check.sh # RPC ritual health check
├── src/
│ ├── css/ # Stylesheets
-│ ├── js/ # JavaScript files
+│ ├── js/ # Front-end JavaScript modules
│ └── assets/ # Images and resources
├── contracts/ # Smart contracts
├── functions/ # Serverless API functions
-└── test/ # Test files
+├── test/ # Unit/integration tests (legacy set)
+└── tests/ # Additional test suites
+```แล้วลบเวอร์ชันที่บรรทัด 354-374 ทั้งหมด
Then remove the entire section at lines 354-374.
Also applies to: 354-374
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 32-32: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` around lines 31 - 48, Remove the duplicate "## Project Structure"
section by keeping the first occurrence (the simpler block under the initial "##
Project Structure" header) and merging in the missing entries from the second
block: add server.js, worker.js, clarify scripts/ entries, change js/ to
"Front-end JavaScript modules", and consolidate tests into "test/
(Unit/integration tests)" plus "tests/ (Additional test suites)" as shown in the
suggested consolidation; then delete the entire second "## Project Structure"
block so only the consolidated single section remains.
| > (`python3 -m http.server 8000` หรือ `npx serve` ใช้เสิร์ฟไฟล์ static ได้ แต่ไม่รองรับ API ของโปรเจกต์นี้). | ||
|
|
||
| ## Project Structure | ||
| ``` |
There was a problem hiding this comment.
เพิ่ม language identifier สำหรับ fenced code block / Add language identifier for fenced code block
Code block ควรระบุ language identifier เพื่อให้สอดคล้องกับ markdown best practices
The fenced code block should specify a language identifier to comply with markdown best practices.
📝 การแก้ไขที่แนะนำ / Proposed fix
-```
+```text
├── index.html # Main dashboard page
├── explorer.html # Mee Ritual Chain ExplorerAs per coding guidelines, markdownlint-cli2 flagged MD040 (fenced-code-language).
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 32-32: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` at line 32, The fenced code block in the README containing the
directory tree snippet (the block with "├── index.html" and "├── explorer.html")
lacks a language identifier; update that fenced block to include a language
(e.g., use ```text) so the block becomes ```text … ``` to satisfy markdownlint
MD040 and improve rendering consistency.
1 participant
Motivation
## Prerequisitesblock to reduce confusion for contributors and maintainers.Prerequisites -> Installation -> Usage -> Project Structurefor easier discoverability./api/*or/rpc/*features.Description
## Prerequisitessection inREADME.mdwith unique dependency items includingModern web browser,Node.js 18+, and the requirement to run vianode server.jsfor API support.Prerequisites,Installation,Usage, thenProject Structureby moving theProject Structureblock directly after theUsageblock.Usagesection clarifying thatnode server.jsis required and thatpython3 -m http.server 8000andnpx serveare static-only and do not support/api/*or/rpc/*.Project Structureplacement so headings and examples are consistent.Testing
rg -n "## Prerequisites|## Installation|## Usage|## Project Structure|python3 -m http.server 8000|npx serve" README.mdand confirmed single## Prerequisitesand presence of clarified usage note.sed -n '1,260p' README.mdto validate the new section order and inserted note.nl -ba README.md | sed -n '1,110p'to confirm thePrerequisites -> Installation -> Usage -> Project Structureordering and that the usage consistency note appears as intended.README.mdupdate is present in the working tree.Codex Task
Summary by CodeRabbit
บันทึกประกาศรุ่นใหม่