modelscope / modelscope/sirchmunk
The 'data/' directory created by 'sirchmunk init' is unused and undocumented
Open
Nobody has claimed this yet.
bug
- Dominant language
- Python
- Stars
- 1.3k
- Forks
- 146
- Avg merge
- 3h 31m
- Merged PRs (30d)
- 6
Description
Description
When running sirchmunk init, a data/ directory is created as part of the working directory structure (cli/cli.py:216-224):
directories = [
work_path,
work_path / "data", # <-- this one
work_path / "logs",
work_path / ".cache",
work_path / ".cache" / "models",
work_path / ".cache" / "knowledge",
work_path / ".cache" / "history",
work_path / ".cache" / "settings",
]
However, this data/ directory appears to be unused and undocumented:
- No code references: No other part of the codebase reads from or writes to this directory. It is only created during
init. - Not a default search path:
SIRCHMUNK_SEARCH_PATHSdoes not default todata/, so Sirchmunk won't automatically search files placed there. - Missing from documentation: The README's "Data Storage" section documents the
.cache/structure but does not mentiondata/.
Suggestion
Either:
- Option A: Remove the
data/directory frominitif it serves no purpose, to keep the workspace clean. - Option B: Give it a clear role — e.g., make it a default search path, document it as the recommended location for user files, and mention it in the README.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in cli/cli.py:216-224 and inspect the README's "Data Storage" section and the SIRCHMUNK_SEARCH_PATHS defaults. Determine whether data/ should be removed or given a documented search-path role; done means the chosen behavior is implemented consistently and the README reflects it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 45/100