Skip to content

Update Wiki #603

Merged
Pavel401 merged 4 commits intoCCExtractor:mainfrom
Manar-Elhabbal7:wikis-updates
Mar 3, 2026
Merged

Update Wiki #603
Pavel401 merged 4 commits intoCCExtractor:mainfrom
Manar-Elhabbal7:wikis-updates

Conversation

@Manar-Elhabbal7
Copy link
Contributor

@Manar-Elhabbal7 Manar-Elhabbal7 commented Feb 23, 2026

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

  1. Home.md

    • Improved layout and readability
    • Added core features of the current application
  2. Architecture.md

    • Updated architecture from STACKED to GetX, which is the current implementation
    • Updated project structure to match the current setup
    • Added correct resources and references for GetX
  3. Contribution-Guidelines-&-Development-Practices.md

    • Improved organization and readability
    • Updated Flutter and Dart versions to the latest releases
    • Clarified contribution and development practices

Related Issue

This PR closes #543

Challenges Faced

  • Updating all files correctly while checking each link, resource, and structure
  • First time contributing to a wiki, so initially struggled with how to edit and raise a PR

Note

I created a docs folder 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

Any feedback will help me a lot.

Thanks :)

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive architecture guide detailing structure, layers, rules, diagrams, and project layout.
    • Introduced contribution & development guidelines covering workflows, commit conventions, naming, and environment tips.
    • Added setup, requirements, and usage pages with step‑by‑step getting‑started and APK instructions.
    • Created a wiki homepage summarizing core features and platform capabilities.
    • Added sidebar and footer content to improve navigation and discoverability.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the git url is not valid it should be ccextractor/

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

update the repo url

docs/License.md Outdated
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use the proper license file that the repo has

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we use flutter-version: "3.29.2"

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@coderabbitai
Copy link

coderabbitai bot commented Mar 3, 2026

Note

Reviews paused

It 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 reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

This 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

Cohort / File(s) Summary
Wiki Navigation & Home
docs/_Sidebar.md, docs/_Footer.md, docs/Home.md
Adds sidebar entries and footer text; introduces a Home page with project overview and core features.
Setup & Usage
docs/Setup-&-Configuration.md, docs/Requirements-&-Usage.md
Adds Getting Started steps for Flutter (clone, deps, flutter doctor, run) and outlines usage paths (dev vs APK).
Architecture & Contribution
docs/Architecture.md, docs/Contribution-Guidelines-&-Development-Practices.md
Adds detailed GetX architecture docs, module layout, architectural rules, contribution workflow, commit conventions, dev environment versions, naming and documentation standards.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 I hopped through pages, tidy and bright,
Laying paths and rules in soft moonlight,
Architecture maps and setup signs,
Contribution carrots on neat little lines,
A hop, a nudge — the wiki's just right! 🥕

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (2 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Update Wiki' is vague and generic, failing to convey the specific changes made (updating outdated documentation to reflect GetX architecture and current application state). Use a more descriptive title like 'Update wiki documentation to reflect GetX architecture and current application state' to clearly communicate the primary change.
Linked Issues check ❓ Inconclusive The PR addresses the core requirement of updating outdated wiki content to match current GetX architecture and project structure, but does not add detailed Taskwarrior server setup instructions as requested in issue #543. Add documentation detailing Taskwarrior server setup and configuration steps as mentioned in issue #543 requirements, or clarify if this is deferred to a future update.
✅ Passed checks (3 passed)
Check name Status Explanation
Description check ✅ Passed The description comprehensively covers the changes, context, and reasoning; however, it does not include the 'Fixes #543' line and the Checklist is incomplete, missing task confirmations.
Out of Scope Changes check ✅ Passed All changes are directly aligned with updating wiki documentation to reflect current application state; no out-of-scope modifications were introduced.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 doctor command should specify a language (e.g., shell or bash) 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 with shell (or bash)
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 closing sequences 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
    with shell (or bash) 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 -->

@Manar-Elhabbal7 Manar-Elhabbal7 requested a review from Pavel401 March 3, 2026 10:24
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

ℹ️ Review info

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 28a3e57 and dc02fdd.

📒 Files selected for processing (1)
  • docs/Contribution-Guidelines-&-Development-Practices.md

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 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 closing fence; 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 closing fence; 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>

---

<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 -->

@Pavel401 Pavel401 merged commit 66aef29 into CCExtractor:main Mar 3, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update the wikis

2 participants