Restructure README with table of contents and improved organization#2
Restructure README with table of contents and improved organization#2
Conversation
- Document all CLI flags including --no-xml, -v/--verbose, -d/--dir-only, --no-auto, --reset-version, and --test-models which were missing - Add documentation for include_patterns global config field (was undocumented) - Add documentation for additional_excludes and additional_includes profile fields (were undocumented) with examples showing per-profile file filtering - Rewrite as practical usage docs rather than a manifesto: quick start, full CLI reference tables, configuration schema, profile field reference, built-in profile descriptions, AI integration, and workflow examples - Remove inaccurate model names from the AI providers table https://claude.ai/code/session_01HxvzW8c1s5f8fzuiXGXMxs
Summary of ChangesHello @FloLey, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly overhauls the Highlights
Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
The pull request significantly improves the README.md by restructuring it with a table of contents and better organization. The changes enhance readability and user onboarding by prioritizing quick-start information and clarifying various sections. The new layout is well-thought-out and makes the documentation much more accessible. The changes are primarily documentation-focused and do not introduce any functional changes to the codebase itself. The restructuring of the README is a positive step towards better user experience.
| |:-----|:------------| | ||
| | `--auto` | Force auto-send to AI after generating the dump. | | ||
| | `--no-auto` | Disable auto-send even if the active profile has `auto_send: true`. | | ||
| | `--model ID` | Override the AI model for this run (e.g. `claude-sonnet-4-5-20250929`). | |
There was a problem hiding this comment.
The example model ID claude-sonnet-4-5-20250929 seems to be a placeholder or an outdated model name. It would be better to use a current and widely recognized model ID for clarity and accuracy, such as claude-3-5-sonnet-latest which is used elsewhere in the document.
| | `--model ID` | Override the AI model for this run (e.g. `claude-sonnet-4-5-20250929`). | | |
| |" --model ID` | Override the AI model for this run (e.g. `claude-3-5-sonnet-latest`). | |
| ## ⚙️ Installation & Configuration | ||
| | Provider | Models | Env var | | ||
| |:---------|:-------|:--------| | ||
| | Anthropic (Claude) | `claude-3-5-sonnet-latest`, `claude-opus-...` | `ANTHROPIC_API_KEY` | |
There was a problem hiding this comment.
The model ID claude-opus-... is incomplete. It should either be a full model ID or a more generic representation if specific versions are not meant to be listed. For consistency, consider using claude-3-opus-20240229 or similar if it's a valid model, or simply claude-opus if it's meant to be a family of models.
| | Anthropic (Claude) | `claude-3-5-sonnet-latest`, `claude-opus-...` | `ANTHROPIC_API_KEY` | | |
| | Anthropic (Claude) | `claude-3-5-sonnet-latest`, `claude-3-opus-20240229` | `ANTHROPIC_API_KEY` | |
| | Provider | Models | Env var | | ||
| |:---------|:-------|:--------| | ||
| | Anthropic (Claude) | `claude-3-5-sonnet-latest`, `claude-opus-...` | `ANTHROPIC_API_KEY` | | ||
| | Google (Gemini) | `gemini-2.5-pro`, `gemini-2.0-flash` | `GOOGLE_API_KEY` | |
There was a problem hiding this comment.
The model ID gemini-2.0-flash is used here, but gemini-3-flash is used in the previous version of the README and gemini-2.5-pro is used in the example. For consistency, it would be better to use the same model ID throughout the document, or clarify the difference between these models.
| | Google (Gemini) | `gemini-2.5-pro`, `gemini-2.0-flash` | `GOOGLE_API_KEY` | | |
| | Google (Gemini) | `gemini-2.5-pro`, `gemini-3-flash` | `GOOGLE_API_KEY` | |
| # With AI support (all providers) | ||
| pip install "git+https://github.com/FloLey/dumpcode.git#egg=dumpcode[ai]" | ||
| # Override the model for this run | ||
| dumpcode --readme --auto --model gemini-2.5-pro |
There was a problem hiding this comment.
The example model ID gemini-2.5-pro is used here, but gemini-3-flash is used in the previous version of the README and gemini-2.0-flash is used in the table above. For consistency, it would be better to use the same model ID throughout the document, or clarify the difference between these models.
| dumpcode --readme --auto --model gemini-2.5-pro | |
| dumpcode --readme --auto --model gemini-3-flash |
2 participants
Summary
Completely restructured the README.md to improve readability, navigation, and user onboarding. The new layout prioritizes quick-start information and provides a clearer information hierarchy with a comprehensive table of contents.
Key Changes
ignore_patterns,include_patterns, and profile-specific file filteringadditional_excludesandadditional_includes, and naming conventionsNotable Details
https://claude.ai/code/session_01HxvzW8c1s5f8fzuiXGXMxs