docs: improve README - #1
Open
webbrain-one wants to merge 1 commit into
Open
Conversation
PR Summary by QodoDocs: clarify README config files and tidy footer
AI Description
High-Level Assessment
Files changed (1)
|
Code Review by Qodo
1. Workflow state doc conflict
|
Comment on lines
413
to
+416
| ├── 📄 settings.json # Agent configuration | ||
| ├── 📄 models.json # Model definitions | ||
| ├── 📄 tool_selection.json # Tool selection settings | ||
| ├── 📄 workflow_state.json # Workflow state (auto-created) |
There was a problem hiding this comment.
1. Workflow state doc conflict 🐞 Bug ⚙ Maintainability
README now claims workflow state is saved in ~/.neoCoder/workflow_state.json, but another repo document states workflow state is saved to .neoCoder/context.md. This inconsistency can cause users to inspect/backup/edit the wrong file when trying to resume workflows or debug persistence.
Agent Prompt
## Issue description
The README now documents `~/.neoCoder/workflow_state.json` as the workflow-state persistence file, but `NEOCODER_MANIFESTO_EN.md` states workflow state is saved to `.neoCoder/context.md`. These statements conflict and can confuse users.
## Issue Context
- README config tree lists `workflow_state.json` as "Workflow state (auto-created)".
- The manifesto describes workflow state being saved to `context.md`.
## Fix Focus Areas
- README.md[409-418]
- NEOCODER_MANIFESTO_EN.md[617-617]
## Suggested resolution
Pick the correct/authoritative behavior and make both documents consistent. If both files exist for different purposes (e.g., `context.md` = session context, `workflow_state.json` = workflow engine state), explicitly document that distinction in both places.
ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools
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.
Makes one small, focused improvement to the existing README.