enhance: Update README.md for Dokan development setup and guidelines #2779
Conversation
WalkthroughThe README.md file was extensively rewritten and restructured to focus on developer documentation, removing marketing and end-user content. In package.json, the "readme" script was deleted, and the "release" script was updated to exclude "readme" step. No changes were made to code or exported entities. Changes
Sequence Diagram(s)No sequence diagram is generated as the changes are limited to documentation and build scripts, with no new or modified control flow. Assessment against linked issues
Assessment against linked issues: Out-of-scope changes
Suggested labels
Suggested reviewers
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (2)
package.json (2)
57-57: Left-over devDependency:wp-readme-to-markdownappears unused.The only consumer of this package – the
readmescript – was deleted. Keeping an unused devDependency increases install time, attack surface, and audit noise.- "wp-readme-to-markdown": "^1.0.1",
58-58: Consolidatetailwind-mergeto a single section
tailwind-mergeis declared twice in package.json with different versions, which can lead to confusion and accidental version drift:
- Line 58 (dependencies):
"tailwind-merge": "^2.6.0"- Line 91 (devDependencies):
"tailwind-merge": "^2.5.5",Keep only one entry—use the section that matches its usage (devDependencies for build tooling, dependencies for runtime)—and delete the other.
Locations to update:
- package.json:58
- package.json:91
Suggested diff (removing the older entry in devDependencies):
--- a/package.json @@ "devDependencies": { - "tailwind-merge": "^2.5.5", }
🧹 Nitpick comments (4)
package.json (1)
20-21: Obsolete script reference removed, but release pipeline still does an extranpm install.
npm installis already implied by the CI/build environment before running the release command. Leaving it inside thereleasescript adds ~ 30 – 60 s (network-dependent) to every release and can create a second, divergingpackage-lock.json.
Consider dropping it for a leaner, deterministic release step.-"release": "npm install && npm run build && npm run clean-files && npm run makepot && npm run version && npm run zip", +"release": "npm run build && npm run clean-files && npm run makepot && npm run version && npm run zip",README.md (3)
49-57: Missing fenced-code language ⇒ markdown-lint warning (MD040).The repository-structure block uses a plain fence ``` without a language hint, triggering lint errors and losing syntax-highlighting. Tag it with
text(or `plaintext`).-``` +```text dokan-lite/ ├── 📂 assets/ # Contains all the frontend and admin assets. @@ └── 📂 languages/ # Translation files.--- `105-108`: **Use the correct compound adjective: “Test-Driven Development”.** Minor wording polish to follow standard terminology. ```diff -Dokan follows **Test Driven Development** (TDD) practices +Dokan follows **Test-Driven Development** (TDD) practices
19-26: Repetitive “all of the” phrasing – tighten for conciseness.The phrase appears four times in close proximity and reads clunky. Example fix for one instance:
-Once you've installed all of the prerequisites, the following will prepare all of the build outputs necessary for development: +After installing the prerequisites, run the following commands to prepare the build outputs for development:Apply similar tightening to the surrounding sentences for a crisper README.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
README.md(1 hunks)package.json(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~15-~15: Consider removing “of” to be more concise
Context: ...o make sure that you have installed all of the prerequisites. ### 📋 Prerequisites *...
(ALL_OF_THE)
[style] ~22-~22: Consider removing “of” to be more concise
Context: ...ro.md)**: We use Composer to manage all of the dependencies for PHP packages and *...
(ALL_OF_THE)
[style] ~26-~26: Consider removing “of” to be more concise
Context: ... it to function. Once you've installed all of the prerequisites, the following will prepa...
(ALL_OF_THE)
[style] ~26-~26: Consider removing “of” to be more concise
Context: ...erequisites, the following will prepare all of the build outputs necessary for development...
(ALL_OF_THE)
[uncategorized] ~107-~107: The adjective “Test-Driven” is spelled with a hyphen.
Context: ...r). | ## 🧪 Testing Dokan follows Test Driven Development (TDD) practices to ensure...
(DRIVEN_HYPHEN)
[uncategorized] ~146-~146: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...etplace plugin for WordPress**. As an open source project, we rely on community contrib...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~146-~146: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ...tions to continue to improve Dokan. Feel free to answer questions on GitHub and with...
(FEEL_FREE_TO_STYLE_ME)
[typographical] ~150-~150: Consider adding a comma here.
Context: ... Dokan: ### Contribution Guidelines Please read our [Contribution Guidelines](...
(PLEASE_COMMA)
[typographical] ~162-~162: It appears that a comma is missing.
Context: ...gress** tracking. ### ✨ Feature Request Do you have a brilliant idea, **enhanc...
(COMMA_BEFORE_QUESTION_WITH_MD)
🪛 markdownlint-cli2 (0.17.2)
README.md
49-49: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: e2e tests (2, 3)
- GitHub Check: api tests (1, 1)
- GitHub Check: e2e tests (1, 3)
- GitHub Check: e2e tests (3, 3)
Following |
…d source file structure
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
README.md (4)
49-49: Add a language identifier to silence MD040markdownlint flags this fenced-code block because it lacks a language specifier. Adding something neutral like
textavoids the warning and improves syntax highlighting.-``` +```text
68-70: Fix typos in the directory tree• “Playwrite” → “Playwright”
• “Utilitiy” → “Utility”-│ └── pw/ # Playwrite tests. +│ └── pw/ # Playwright tests. … -│ └── utilities/ # Utilitiy functions for reactive frontend. +│ └── utilities/ # Utility functions for reactive frontend.
127-129: Hyphenate compound adjective “Test-Driven”-Dokan follows **Test Driven Development** (TDD) practices +Dokan follows **Test-Driven Development** (TDD) practices
166-166: Hyphenate “open-source”Maintains consistency with common OSS terminology.
-As an **open source project**, we rely on community contributions +As an **open-source project**, we rely on community contributions
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[style] ~15-~15: Consider removing “of” to be more concise
Context: ...o make sure that you have installed all of the prerequisites. ### 📋 Prerequisites *...
(ALL_OF_THE)
[style] ~22-~22: Consider removing “of” to be more concise
Context: ...ro.md)**: We use Composer to manage all of the dependencies for PHP packages and *...
(ALL_OF_THE)
[style] ~26-~26: Consider removing “of” to be more concise
Context: ... it to function. Once you've installed all of the prerequisites, the following will prepa...
(ALL_OF_THE)
[style] ~26-~26: Consider removing “of” to be more concise
Context: ...erequisites, the following will prepare all of the build outputs necessary for development...
(ALL_OF_THE)
[uncategorized] ~127-~127: The adjective “Test-Driven” is spelled with a hyphen.
Context: ...r). | ## 🧪 Testing Dokan follows Test Driven Development (TDD) practices to ensure...
(DRIVEN_HYPHEN)
[uncategorized] ~166-~166: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...etplace plugin for WordPress**. As an open source project, we rely on community contrib...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[style] ~166-~166: Consider using a less common alternative to make your writing sound more unique and professional.
Context: ...tions to continue to improve Dokan. Feel free to answer questions on GitHub and with...
(FEEL_FREE_TO_STYLE_ME)
[typographical] ~170-~170: Consider adding a comma here.
Context: ... Dokan: ### Contribution Guidelines Please read our [Contribution Guidelines](...
(PLEASE_COMMA)
[typographical] ~182-~182: It appears that a comma is missing.
Context: ...gress** tracking. ### ✨ Feature Request Do you have a brilliant idea, **enhanc...
(COMMA_BEFORE_QUESTION_WITH_MD)
🪛 markdownlint-cli2 (0.17.2)
README.md
49-49: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: e2e tests (2, 3)
- GitHub Check: e2e tests (3, 3)
- GitHub Check: e2e tests (1, 3)
- GitHub Check: api tests (1, 1)
All Submissions:
Changes proposed in this Pull Request:
Related Pull Request(s)
Closes
How to test the changes in this Pull Request:
Changelog entry
docs: Update README.md with Dokan development setup and guidelines.Detailed Description of the pull request. What was previous behaviour
and what will be changed in this PR.
Before Changes
Describe the issue before changes with screenshots(s).
After Changes
Describe the issue after changes with screenshot(s).
Feature Video (optional)
Link of detailed video if this PR is for a feature.
PR Self Review Checklist:
FOR PR REVIEWER ONLY:
Summary by CodeRabbit
Documentation
Chores