docs: add "How It Works" section to README (EN + ZH) - #16
Merged
Merged
Conversation
Agent-Logs-Url: https://github.com/axetroy/dedust/sessions/1f709c3e-b768-48ce-a1e2-03b9056caac2 Co-authored-by: axetroy <9758711+axetroy@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
axetroy
April 24, 2026 08:45
View session
axetroy
marked this pull request as ready for review
April 24, 2026 08:46
Co-authored-by: Copilot <copilot@github.com>
…s handling in tests Co-authored-by: Copilot <copilot@github.com>
Co-authored-by: Copilot <copilot@github.com>
axetroy
approved these changes
Apr 27, 2026
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
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.
Adds a bilingual "How It Works" section to both
README.mdandREADME_zh-CN.md, explaining dedust's internal pipeline for users who want to understand what happens under the hood.Changes
README.md— New section inserted between "Features" and "Installation" covering the 5-stage pipeline with an ASCII flow diagram:Tokenizerproduces a typed token stream from raw DSL textParserbuilds structured rule objects (action + target glob + condition tree withand/not/location modifiers)Validatorrejects broad patterns (delete *,delete **/*) lacking conditionsEvaluatorrecursively walksbaseDir, applyingignore/skipsemantics and resolving spatial predicates (parent,parents,child,children,sibling) per directory.execute()sorts targets deepest-first and deletes via Node.jsfsAPIs, capturing errors non-fatallyREADME_zh-CN.md— Full Chinese translation of the same section, placed at the same position