docs(readme): improve documentation structure and fix processors config typo - #156
Merged
Conversation
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
1 participant
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.
Description
This PR updates various documentation files, improves the project's README structure, and fixes configuration-related typos in the guide.
Changes
docs/notes/regarding faloo and added additional information for qidian.README.mdto simplify content and link to the new MkDocs GitHub Pages site instead of containing long-form documentation.README.en.mdfor English readers.docs/guide/related to processors configuration ([[plugins.processors]]->[[general.processors]]).Motivation
These changes improve clarity, reduce duplication between README and documentation site, and correct configuration mistakes that might confuse users.
Type of change
Checklist