GSoC2026 : Docs Refactoring (Issue #86)

[DhanashreePetare]

Description

Restructures project documentation :

• README.md kept slim: Quickstart, DBpedia (Docker commands removed, Docker mentioned once overall), a new GSoC 2026 section, Development & Contributing, plus short CLI/module overviews linking out to detailed docs.
• Detailed CLI documentation (download/deploy/delete/manifest/workflow) moved to doc/cli-usage.md.
• Python module usage documentation moved to doc/module-usage.md.
• Examples moved to doc/examples/, including all workflow example files.
• Added doc/README.md as a navigation index for the documentation folder.

Related Issues

Closes #86

Type of change

• Housekeeping

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: ede552af-e809-44cd-b9a8-c06a7aaad680

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[DhanashreePetare]

The proposal link attached is correct but not showing the document, I will update that with a drive link of proposal.

[Integer-Ctrl]

What about https://github.com/DhanashreePetare/databus-python-client/blob/gsoc-2026/run_all_conversion_tests.py?

[DhanashreePetare]

What about https://github.com/DhanashreePetare/databus-python-client/blob/gsoc-2026/run_all_conversion_tests.py?

Yes, those sample commands are stale and should be updated to the current CLI syntax. They are not part of the public docs, but they are still examples that can mislead users, used it for testing though.

[Integer-Ctrl]

Based on the changes, are you relying solely on agents/LLMs to refactor the documentation?

[Integer-Ctrl]

What about https://github.com/DhanashreePetare/databus-python-client/blob/gsoc-2026/run_all_conversion_tests.py?

Yes, those sample commands are stale and should be updated to the current CLI syntax. They are not part of the public docs, but they are still examples that can mislead users, used it for testing though.

So removing or keeping?

[DhanashreePetare]

Based on the changes, are you relying solely on agents/LLMs to refactor the documentation?

No, actually I faced some commit issues, my commits somehow got mixed up, the codes I mean..and so it is happening likewise, still trying to fix all work. I have decided that, if this doesn't get resolved in time, I will fetch the merged work and redo every doc change.

[DhanashreePetare]

What about https://github.com/DhanashreePetare/databus-python-client/blob/gsoc-2026/run_all_conversion_tests.py?

Yes, those sample commands are stale and should be updated to the current CLI syntax. They are not part of the public docs, but they are still examples that can mislead users, used it for testing though.

So removing or keeping?

Keeping it, I have updated it with newer work, and have replaced it is test/manual folder just so that it stays clean.

[DhanashreePetare]

Based on the changes, are you relying solely on agents/LLMs to refactor the documentation?

No, actually I faced some commit issues, my commits somehow got mixed up, the codes I mean..and so it is happening likewise, still trying to fix all work. I have decided that, if this doesn't get resolved in time, I will fetch the merged work and redo every doc change.

The current commit is done by restoring the actual previous documentation from merged commit of milestone 5, with doc fixes applied. I hope it tries to clean what was messed up, will recheck everything myself once again.

[Integer-Ctrl]

What about https://github.com/DhanashreePetare/databus-python-client/blob/gsoc-2026/run_all_conversion_tests.py?

Yes, those sample commands are stale and should be updated to the current CLI syntax. They are not part of the public docs, but they are still examples that can mislead users, used it for testing though.

So removing or keeping?

Keeping it, I have updated it with newer work, and have replaced it is test/manual folder just so that it stays clean.

Alright, sounds good. To make it runnable some test data is needed. Current output is Total: 0 passed, 6 failed, 14 skipped because BASE_TTL, BASE_NQ etc do not exist. Test data could be under tests/resources

[DhanashreePetare]

these 2 blocks from [DBpedia Knowledge Graphs] section in root readme.md seems completely same to me, am i missing on any difference between them or are they intentional ? if not, I can remove them.

[DhanashreePetare]

What about https://github.com/DhanashreePetare/databus-python-client/blob/gsoc-2026/run_all_conversion_tests.py?

Yes, those sample commands are stale and should be updated to the current CLI syntax. They are not part of the public docs, but they are still examples that can mislead users, used it for testing though.

So removing or keeping?

Keeping it, I have updated it with newer work, and have replaced it is test/manual folder just so that it stays clean.

Alright, sounds good. To make it runnable some test data is needed. Current output is Total: 0 passed, 6 failed, 14 skipped because BASE_TTL, BASE_NQ etc do not exist. Test data could be under tests/resources

yes, added the data in resources and after testing now got Total: 20 passed, 0 failed, 0 skipped.