Conversation
There was a problem hiding this comment.
the git url is not valid it should be ccextractor/
docs/License.md
Outdated
There was a problem hiding this comment.
Please use the proper license file that the repo has
There was a problem hiding this comment.
I think we use flutter-version: "3.29.2"
There was a problem hiding this comment.
Use this url https://github.com/CCExtractor/taskwarrior-flutter
There was a problem hiding this comment.
Thanks a lot for the guidance! I updated all the URLs, removed the redundant License.md file, and fixed the code block formatting. Please review again
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThis PR adds and updates project documentation: architecture, contribution/development guidelines, setup/configuration, requirements/usage, homepage, and sidebar/footer navigation. No source code or public API changes are included. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (2 inconclusive)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/Setup-&-Configuration.md (1)
14-17: Add language specifier to the code block.The fenced code block for the
flutter doctorcommand should specify a language (e.g.,shellorbash) for proper syntax highlighting and rendering.📝 Proposed fix
4. Check for Flutter setup and connected devices: -``` +```shell flutter doctor</details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@docs/Setup-&-Configuration.md around lines 14 - 17, The fenced code block
that contains the flutter command (the block with "flutter doctor") should
include a language specifier (e.g., shell or bash) for proper syntax
highlighting; update that fenced block to begin withshell (orbash)
instead of just ``` so the "flutter doctor" snippet is rendered correctly.</details> </blockquote></details> </blockquote></details> <details> <summary>🤖 Prompt for all review comments with AI agents</summary>Verify each finding against the current code and only fix it if needed.
Inline comments:
In@docs/Contribution-Guidelines-&-Development-Practices.md:
- Around line 32-38: Remove the escaped backticks and replace them with a proper
fenced code block by deleting the backslashes before the opening and closingsequences and add a language specifier (e.g., "text") after the opening fence so the block readstext ...; update the block around the Flutter/Dart version lines (the fenced block currently shown with "\") accordingly.
Nitpick comments:
In@docs/Setup-&-Configuration.md:
- Around line 14-17: The fenced code block that contains the flutter command
(the block with "flutter doctor") should include a language specifier (e.g.,
shell or bash) for proper syntax highlighting; update that fenced block to begin
withshell (orbash) instead of just ``` so the "flutter doctor" snippet
is rendered correctly.</details> --- <details> <summary>ℹ️ Review info</summary> **Configuration used**: defaults **Review profile**: CHILL **Plan**: Pro <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 588fc49473e774251371d6aa51dd4146674ee595 and 28a3e57c8887c43e61baaa9bad01b00782e17145. </details> <details> <summary>📒 Files selected for processing (7)</summary> * `docs/Architecture.md` * `docs/Contribution-Guidelines-&-Development-Practices.md` * `docs/Home.md` * `docs/Requirements-&-Usage.md` * `docs/Setup-&-Configuration.md` * `docs/_Footer.md` * `docs/_Sidebar.md` </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/Contribution-Guidelines-`&-Development-Practices.md:
- Line 63: Update the Zulip link on the "💬 [Join CCExtractor on Zulip]" line by
replacing the colon-separated path with slashes: change the URL from
https://ccextractor.org/public:general:support to
https://ccextractor.org/public/general/support so the link points to the correct
Zulip community page.
- Around line 48-52: The documentation currently references a non-existent theme
path under the "UI/UX Constants" section; update the path string
`/lib/app/themes/themes.dart` to the correct `/lib/app/utils/themes/themes.dart`
in lines referencing UI/UX constants so the theme file location is accurate in
the documentation.
- Around line 32-38: The documented SDK/revision dates in the Flutter/Dart
version block are inconsistent; update the date text in the fenced code block
that contains "Flutter 3.29.2 • channel stable" and "Dart 3.7.2 • DevTools
2.42.3" so the Dart release date is corrected to "2025-03-12" or add a
clarifying note that "2026-02-18" refers specifically to the framework revision
snapshot (e.g., append "— framework revision date" or similar) to make the
distinction explicit.
5d40e1d to
0c6ede8
Compare
There was a problem hiding this comment.
🧹 Nitpick comments (2)
docs/Contribution-Guidelines-&-Development-Practices.md (2)
32-32: Clarify or remove the "as of 23 Feb 2026" phrase.The phrase "as of 23 Feb 2026" could confuse readers since Dart 3.7.2 was released nearly a year earlier (2025-03-12) and the framework revision date is 2026-02-18. Consider either removing the parenthetical clause entirely or rephrasing to clarify what "as of" refers to (e.g., "verified 23 Feb 2026" or "documentation updated 23 Feb 2026").
✏️ Suggested clarification
-Use **Flutter 3.29.2** or later for development (as of 23 Feb 2026): +Use **Flutter 3.29.2** or later for development:or
-Use **Flutter 3.29.2** or later for development (as of 23 Feb 2026): +Use **Flutter 3.29.2** or later for development (documentation updated 23 Feb 2026):🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/Contribution-Guidelines-`&-Development-Practices.md at line 32, Update the line "Use **Flutter 3.29.2** or later for development (as of 23 Feb 2026):" to remove or clarify the parenthetical date—either delete "(as of 23 Feb 2026)" entirely, or replace it with a clearer phrase such as "(verified 23 Feb 2026)" or "(documentation updated 23 Feb 2026)" so readers understand what the date refers to; edit the same string in the docs/Contribution-Guidelines-&-Development-Practices.md file.
34-39: Remove the extra blank line in the code block.Line 38 contains an unnecessary blank line before the closing fence. While this doesn't break rendering, removing it improves consistency.
🧹 Suggested cleanup
```text Flutter 3.29.2 • channel stable Framework • revision 90673a4eef • 2026-02-18 (framework revision date) Dart 3.7.2 • DevTools 2.42.3 • released 2025-03-12 -</details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@docs/Contribution-Guidelines-&-Development-Practices.md around lines 34 -
39, The fenced code block showing Flutter/Dart versions contains an extra blank
line before the closingfence; edit the Markdown so the block ends immediately after "Dart 3.7.2 • DevTools 2.42.3 • released 2025-03-12" with no blank line (i.e., remove the empty line between that text and the closing
fence in the code block).</details> </blockquote></details> </blockquote></details> <details> <summary>🤖 Prompt for all review comments with AI agents</summary>Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In@docs/Contribution-Guidelines-&-Development-Practices.md:
- Line 32: Update the line "Use Flutter 3.29.2 or later for development (as
of 23 Feb 2026):" to remove or clarify the parenthetical date—either delete "(as
of 23 Feb 2026)" entirely, or replace it with a clearer phrase such as
"(verified 23 Feb 2026)" or "(documentation updated 23 Feb 2026)" so readers
understand what the date refers to; edit the same string in the
docs/Contribution-Guidelines-&-Development-Practices.md file.- Around line 34-39: The fenced code block showing Flutter/Dart versions
contains an extra blank line before the closingfence; edit the Markdown so the block ends immediately after "Dart 3.7.2 • DevTools 2.42.3 • released 2025-03-12" with no blank line (i.e., remove the empty line between that text and the closingfence in the code block).</details> --- <details> <summary>ℹ️ Review info</summary> **Configuration used**: defaults **Review profile**: CHILL **Plan**: Pro <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 5d40e1d5f6e397e4b7795cee675b4e66fc8dadb7 and 0c6ede83d327340407e59f024d822a2fe3768ace. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `docs/Contribution-Guidelines-&-Development-Practices.md` </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
0c6ede8 to
68aa778
Compare
68aa778 to
4413680
Compare
Description
This PR updates the project wiki, which was last updated in 2022 and contained outdated architecture and data. The wiki now reflects the current state of the application, with updated structure, resources, and guidelines.
Files Updated
Home.mdArchitecture.mdContribution-Guidelines-&-Development-Practices.mdRelated Issue
This PR closes #543
Challenges Faced
Note
I created a
docsfolder containing the updated wiki files because I did not have direct access to edit the project wiki.If there is a preferred or alternative way to contribute to the wiki, I would greatly appreciate your guidance.
This is my first time contributing to a wiki, and any feedback will help me a lot
Thanks :)
Summary by CodeRabbit