docs: Removed broken links from README.md
#818
Conversation
- Removed broken GitHub source code path references from Ontology, DataParser, and Util sections - Removed broken relative links (Build-from-Source-with-Maven, Installation, Run-from-Java-or-Scala, Run-from-a-JAR) - Added HTML comments documenting which links were removed
📝 WalkthroughWalkthroughREADME.md updated: broken data-flow image replaced with an archived URL and note; internal Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md
🧰 Additional context used
🪛 LanguageTool
README.md
[uncategorized] ~7-~7: Did you mean the communication tool “Slack” (= proper noun, capitalized)?
Context: ...//dbpedia.slack.com/archives/C0L9MJFU7) slack channel within the DBpedia Slack worksp...
(ON_SKYPE)
[grammar] ~7-~7: Ensure spelling is correct
Context: ...a Slack workspace - the main point for [developement updates](https://github.com/dbpedia/ext...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🪛 markdownlint-cli2 (0.18.1)
README.md
130-130: Bare URL used
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
- GitHub Check: long-running-tests
- GitHub Check: build
- GitHub Check: deploy
- GitHub Check: build
- GitHub Check: build
🔇 Additional comments (2)
README.md (2)
64-64: Documentation cleanup is appropriate.Removing the broken Data flow image reference with an HTML comment is a clean way to document the change. This aligns well with the PR objective.
79-84: Well-executed link removal and documentation.Converting the broken GitHub source code links to inline code formatting (backticks) for the namespace references and documenting the removal with HTML comments is a clear and maintainable approach. The namespace references are preserved in a readable format while broken links are cleanly removed.
|
It looks like the deploy job failed with a 403 Forbidden error because it's trying to upload artifacts from a forked repository. Since I don't have write access to the package registry, this step is expected to fail. @JJ-Author |
README.md
Outdated
| **Documentation**: http://dev.dbpedia.org/Extraction <br/> | ||
| **Get in touch with DBpedia**: https://wiki.dbpedia.org/join/get-in-touch <br/> | ||
| **Slack**: join the [**#dev-team**](https://dbpedia.slack.com/archives/C0L9MJFU7) slack channel within the the [DBpedia Slack workspace](https://dbpedia-slack.herokuapp.com/) - the main point for [developement updates](https://github.com/dbpedia/extraction-framework/blob/master/.github/workflows/maven.yml) and discussions <br/> | ||
| **Slack**: join the [**#dev-team**](https://dbpedia.slack.com/archives/C0L9MJFU7) slack channel within the DBpedia Slack workspace - the main point for [developement updates](https://github.com/dbpedia/extraction-framework/blob/master/.github/workflows/maven.yml) and discussions <br/> |
There was a problem hiding this comment.
| **Slack**: join the [**#dev-team**](https://dbpedia.slack.com/archives/C0L9MJFU7) slack channel within the DBpedia Slack workspace - the main point for [developement updates](https://github.com/dbpedia/extraction-framework/blob/master/.github/workflows/maven.yml) and discussions <br/> | |
| **Slack**: join the [**#dev-team**](https://dbpedia.slack.com/archives/C0L9MJFU7) Slack channel within the DBpedia Slack workspace — the main point for [development updates](https://github.com/dbpedia/extraction-framework/blob/master/.github/workflows/maven.yml) and discussions <br/> |
There was a problem hiding this comment.
okay i have fixed the typos and formats
README.md
Outdated
| ### Core Module | ||
|
|
||
|  | ||
| <!-- Data flow image removed - original link was broken --> |
There was a problem hiding this comment.
| <!-- Data flow image removed - original link was broken --> | |
| <!-- original link to Data flow image was broken -- replaced by archive.org link --> | |
|  |
There was a problem hiding this comment.
added the correct links
This appears to be inaccurate. A more accurate statement appears to be "Removed broken or outdated links" which is far less helpful, especially when functioning links can be found or constructed. I've suggested a few already. Perhaps you can revise the other "Removed broken" changes? |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In @README.md:
- Around line 79-85: Replace the markdown link for the ontology namespace with
inline code formatting to match the other entries: change
`[org.dbpedia.extraction.ontology](core/src/main/scala/org/dbpedia/extraction/ontology)`
to use backticks as `org.dbpedia.extraction.ontology`, keeping the surrounding
sentence identical so all three namespaces (`org.dbpedia.extraction.ontology`,
`org.dbpedia.extraction.dataparser`, `org.dbpedia.extraction.util`) use the same
inline code style.
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md
🧰 Additional context used
🪛 LanguageTool
README.md
[uncategorized] ~7-~7: Did you mean the communication tool “Slack” (= proper noun, capitalized)?
Context: ...//dbpedia.slack.com/archives/C0L9MJFU7) slack channel within the DBpedia Slack worksp...
(ON_SKYPE)
[grammar] ~7-~7: Ensure spelling is correct
Context: ...a Slack workspace - the main point for [developement updates](https://github.com/dbpedia/ext...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🪛 markdownlint-cli2 (0.18.1)
README.md
131-131: Bare URL used
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
- GitHub Check: build
- GitHub Check: build
- GitHub Check: deploy
- GitHub Check: build
- GitHub Check: long-running-tests
🔇 Additional comments (1)
README.md (1)
64-64: Approve removal of broken DataFlow image reference.Replacing the broken image link with a clear HTML comment appropriately documents the removal and aligns with the PR objectives.
README.md
Outdated
| * **Ontology** Classes used to represent an ontology. Methods for both, reading and writing ontologies are provided. All classes are located in the namespace [org.dbpedia.extraction.ontology](core/src/main/scala/org/dbpedia/extraction/ontology) | ||
|
|
||
|
|
||
| * **DataParser** Parsers to extract data from nodes in the abstract syntax tree. All classes are located in the namespace `org.dbpedia.extraction.dataparser` | ||
| <!-- Broken link removed: previously linked to dataparser source --> | ||
| * **Util** Various utility classes. All classes are located in the namespace `org.dbpedia.extraction.util` | ||
| <!-- Broken link removed: previously linked to util source --> |
There was a problem hiding this comment.
🛠️ Refactor suggestion | 🟠 Major
Inconsistent formatting in Ontology, DataParser, and Util namespace references.
Line 79 formats the namespace reference as a markdown link [org.dbpedia.extraction.ontology](core/src/main/scala/org/dbpedia/extraction/ontology), but lines 82 and 84 use inline code formatting with backticks (`org.dbpedia.extraction.dataparser` and `org.dbpedia.extraction.util`). For consistency, line 79 should use the same code formatting pattern as lines 82 and 84.
🎨 Proposed fix for consistency
-* **Ontology** Classes used to represent an ontology. Methods for both, reading and writing ontologies are provided. All classes are located in the namespace [org.dbpedia.extraction.ontology](core/src/main/scala/org/dbpedia/extraction/ontology)
+* **Ontology** Classes used to represent an ontology. Methods for both, reading and writing ontologies are provided. All classes are located in the namespace `org.dbpedia.extraction.ontology`📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| * **Ontology** Classes used to represent an ontology. Methods for both, reading and writing ontologies are provided. All classes are located in the namespace [org.dbpedia.extraction.ontology](core/src/main/scala/org/dbpedia/extraction/ontology) | |
| * **DataParser** Parsers to extract data from nodes in the abstract syntax tree. All classes are located in the namespace `org.dbpedia.extraction.dataparser` | |
| <!-- Broken link removed: previously linked to dataparser source --> | |
| * **Util** Various utility classes. All classes are located in the namespace `org.dbpedia.extraction.util` | |
| <!-- Broken link removed: previously linked to util source --> | |
| * **Ontology** Classes used to represent an ontology. Methods for both, reading and writing ontologies are provided. All classes are located in the namespace `org.dbpedia.extraction.ontology` | |
| * **DataParser** Parsers to extract data from nodes in the abstract syntax tree. All classes are located in the namespace `org.dbpedia.extraction.dataparser` | |
| <!-- Broken link removed: previously linked to dataparser source --> | |
| * **Util** Various utility classes. All classes are located in the namespace `org.dbpedia.extraction.util` | |
| <!-- Broken link removed: previously linked to util source --> |
🤖 Prompt for AI Agents
In @README.md around lines 79 - 85, Replace the markdown link for the ontology
namespace with inline code formatting to match the other entries: change
`[org.dbpedia.extraction.ontology](core/src/main/scala/org/dbpedia/extraction/ontology)`
to use backticks as `org.dbpedia.extraction.ontology`, keeping the surrounding
sentence identical so all three namespaces (`org.dbpedia.extraction.ontology`,
`org.dbpedia.extraction.dataparser`, `org.dbpedia.extraction.util`) use the same
inline code style.
vaibhav45sktech
force-pushed
the
fix/remove-broken-readme-links
branch
from
cb7e248 to
7ae92e5
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In @README.md:
- Line 132: The README line contains a bare URL which violates MD034; replace
the plain URL "https://forum.dbpedia.org" with a markdown link (e.g., [DBpedia
Forum](https://forum.dbpedia.org)) so both links on that line are properly
formatted as markdown links and comply with linting.
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (33)
dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L11/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L220661/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L221495/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L221521/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L221524/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L222070/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L222071/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L222072/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L222073/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L222074/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L222075/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L222076/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L222077/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L222078/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L222261/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L222262/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L222327/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L222354/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L222359/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L222360/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L222361/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L222473/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L240/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L247/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L249/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L536/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L61/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L63240/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Property:P7531/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Property:P7532/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Property:P7555/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Property:P7556/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Property:P7558/wiki.xml.bz2is excluded by!**/*.bz2
📒 Files selected for processing (2)
README.mddump/src/test/resources/shacl-tests/instances/?_(film)_citation1.ttl
💤 Files with no reviewable changes (1)
- dump/src/test/resources/shacl-tests/instances/?_(film)_citation1.ttl
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md
132-132: Bare URL used
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
- GitHub Check: build
- GitHub Check: build
- GitHub Check: long-running-tests
- GitHub Check: deploy
- GitHub Check: build
🔇 Additional comments (1)
README.md (1)
80-85: Inconsistent namespace formatting differs from past review suggestion.The past review recommended changing the namespace references in the Ontology, DataParser, and Util sections to use inline code formatting with backticks (e.g.,
`org.dbpedia.extraction.ontology`) for consistency. However, these lines now contain markdown links to absolute GitHub URLs instead. This approach deviates from the prior feedback.Additionally, the extra blank lines inserted between list items (lines 81–82, 84, 86) create formatting inconsistency within the bullet-point list.
Please clarify whether the absolute GitHub URL approach is preferred over inline code formatting, or whether the inline code formatting suggestion from the prior review should be implemented. If GitHub links are intentional, consider removing the extra blank lines to maintain list consistency.
README.md
Outdated
| - [Downloads](https://www.dbpedia.org/resources/downloads/) some data to work with. | ||
| - How to run from [Scala/Java](https://github.com/dbpedia/extraction-framework/blob/master/documentation/quickstart.md) or from a [JAR.](https://github.com/dbpedia/extraction-framework/blob/master/documentation/quickstart.md) | ||
|
|
||
| - Having different troubles? Check the [troubleshooting page](https://www.dbpedia.org/sample-page/) or post on https://forum.dbpedia.org. |
There was a problem hiding this comment.
Format bare URL as markdown link (unresolved from prior feedback).
Line 132 contains a bare URL that was previously flagged and should be formatted as a proper markdown link to comply with markdown linting standards (MD034).
🔎 Proposed fix
-Having different troubles? Check the [troubleshooting page](https://www.dbpedia.org/sample-page/) or post on https://forum.dbpedia.org.
+Having different troubles? Check the [troubleshooting page](https://www.dbpedia.org/sample-page/) or [post on the DBpedia Forum](https://forum.dbpedia.org).📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - Having different troubles? Check the [troubleshooting page](https://www.dbpedia.org/sample-page/) or post on https://forum.dbpedia.org. | |
| - Having different troubles? Check the [troubleshooting page](https://www.dbpedia.org/sample-page/) or [post on the DBpedia Forum](https://forum.dbpedia.org). |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
132-132: Bare URL used
(MD034, no-bare-urls)
🤖 Prompt for AI Agents
In @README.md at line 132, The README line contains a bare URL which violates
MD034; replace the plain URL "https://forum.dbpedia.org" with a markdown link
(e.g., [DBpedia Forum](https://forum.dbpedia.org)) so both links on that line
are properly formatted as markdown links and comply with linting.
7ae92e5 to
3f9d62f
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
README.md (2)
63-65: Improve image alt text for accessibility.The archived image link is properly documented with an HTML comment. However, the image alt text is currently a bare URL, which does not serve accessibility purposes. Consider replacing it with a descriptive alt text.
♻️ Suggested improvement
- +
80-85: Minor formatting adjustment: consider removing extra blank lines between list items.The namespace references have been updated with functional absolute GitHub URLs, which resolves the broken relative path issue. However, the extra blank lines (lines 81-82, 84) between list items create uneven spacing in the bullets section. For consistency with standard markdown list formatting, these blank lines should be removed.
♻️ Proposed formatting cleanup
* **Ontology** Classes used to represent an ontology. Methods for both, reading and writing ontologies are provided. All classes are located in the namespace [org.dbpedia.extraction.ontology](https://github.com/dbpedia/extraction-framework/tree/master/core/src/main/scala/org/dbpedia/extraction/ontology) - - * **DataParser** Parsers to extract data from nodes in the abstract syntax tree. All classes are located in the namespace [org.dbpedia.extraction.dataparser](https://github.com/dbpedia/extraction-framework/tree/master/core/src/main/scala/org/dbpedia/extraction/dataparser) - * **Util** Various utility classes. All classes are located in the namespace [org.dbpedia.extraction.util](https://github.com/dbpedia/extraction-framework/tree/master/core/src/main/scala/org/dbpedia/extraction/util)
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md
132-132: Bare URL used
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
- GitHub Check: build
- GitHub Check: deploy
- GitHub Check: build
- GitHub Check: build
- GitHub Check: long-running-tests
🔇 Additional comments (1)
README.md (1)
7-7: Slack reference line is properly formatted.All previous typos and style issues (capitalization of "Slack," spelling of "development," and em dash punctuation) have been correctly addressed.
|
Greetings @TallTed . Thanks for the review! I have updated the PR to replace the broken links with functional targets instead of removing them, as requested. Regarding lines 127–132 (Maven Build, Run from Scala/Java, Troubleshooting): The original files referenced in the README no longer exist in the repository, and there were no links in the raw code to preserve. Maven Build: I have redirected this to the Maven-Instructions page on the project Wiki. Run from Scala/Java: I have redirected these to the quickstart.md documentation. Troubleshooting: I have redirected this to the sample-page on dbpedia.org. Please let me know if these new targets look correct to you or if you would prefer different destinations for these specific sections. |
|
Looks OK on quick review. More eyes are welcome. |
|
Thanks for the review @TallTed . |
|
Hii @TallTed |
vaibhav45sktech
force-pushed
the
fix/remove-broken-readme-links
branch
from
55d1057 to
b25a530
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In @README.md:
- Around line 127-132: Replace the bare URL in the last bullet
("https://forum.dbpedia.org") with proper Markdown link syntax; locate the
bullet that currently ends with the plain forum URL and change it to a
descriptive link label (for example "DBpedia forum" or "community forum") using
[Label](https://forum.dbpedia.org) so the README no longer contains a bare URL.
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (33)
dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L11/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L220661/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L221495/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L221521/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L221524/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L222070/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L222071/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L222072/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L222073/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L222074/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L222075/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L222076/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L222077/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L222078/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L222261/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L222262/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L222327/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L222354/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L222359/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L222360/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L222361/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L222473/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L240/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L247/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L249/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L536/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L61/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Lexeme:L63240/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Property:P7531/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Property:P7532/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Property:P7555/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Property:P7556/wiki.xml.bz2is excluded by!**/*.bz2dump/src/test/resources/minidumps/wikidata.org/wiki/Property:P7558/wiki.xml.bz2is excluded by!**/*.bz2
📒 Files selected for processing (2)
README.mddump/src/test/resources/shacl-tests/instances/?_(film)_citation1.ttl
💤 Files with no reviewable changes (1)
- dump/src/test/resources/shacl-tests/instances/?_(film)_citation1.ttl
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md
132-132: Bare URL used
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
- GitHub Check: build
- GitHub Check: build
- GitHub Check: long-running-tests
- GitHub Check: build
- GitHub Check: deploy
🔇 Additional comments (2)
README.md (2)
63-65: No action needed. The archived image link is functional and properly formatted.The archive.org URL with the
if_modifier is valid and correctly serves the PNG image without the Wayback toolbar overlay—making it the appropriate choice for an embedded image in documentation. The HTML comment documenting the broken link replacement is good practice and improves maintainability.
80-80: GitHub links in README.md are valid and accessible.Verification confirms all three referenced GitHub tree paths exist and are accessible on the master branch:
core/src/main/scala/org/dbpedia/extraction/ontology✓core/src/main/scala/org/dbpedia/extraction/dataparser✓ (contains files like ObjectParser.scala)core/src/main/scala/org/dbpedia/extraction/util✓ (contains utility classes)No action required.
vaibhav45sktech
force-pushed
the
fix/remove-broken-readme-links
branch
from
b25a530 to
7ae92e5
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
.gitignore (1)
11-13: Consider scoping the.bz2pattern to the test directory.The wildcard pattern
*.bz2on Line 13 is very broad and will ignore.bz2files anywhere in the repository. If there are any intentional.bz2test fixtures or legitimate artifacts that should be committed, they will be unintentionally ignored.Consider scoping the pattern to the minidumps directory to avoid over-exclusion:
♻️ Proposed refinement
# Generated test dumps src/test/resources/minidumps/ - *.bz2 + src/test/resources/minidumps/*.bz2
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.gitignore
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
- GitHub Check: build
- GitHub Check: deploy
- GitHub Check: build
- GitHub Check: build
- GitHub Check: long-running-tests
vaibhav45sktech
force-pushed
the
fix/remove-broken-readme-links
branch
from
ea25068 to
0307ae3
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In @README.md:
- Around line 127-132: Replace the bare URL "https://forum.dbpedia.org" with a
markdown link and remove the extra space before "or": update the sentence in
README.md (the paragraph that currently reads "...or post on
https://forum.dbpedia.org.") to use link syntax like
[forum.dbpedia.org](https://forum.dbpedia.org) so it complies with MD034 and
fixes the spacing inconsistency.
🧹 Nitpick comments (1)
README.md (1)
63-65: Good fallback for broken image link.Using archive.org as a fallback for the broken data flow diagram is a reasonable approach, and the HTML comment appropriately documents why the change was made.
Consider improving the image alt text and title for readability (currently uses the archive.org URL, which could be more descriptive). This is a minor optional improvement.
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
README.md
132-132: Bare URL used
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
- GitHub Check: build
- GitHub Check: build
- GitHub Check: build
- GitHub Check: deploy
- GitHub Check: long-running-tests
🔇 Additional comments (1)
README.md (1)
7-7: Stylistic improvement with em dash.The punctuation change from hyphen to em dash is a minor but appropriate stylistic enhancement.
|
Greetings @JJ-Author . Could you please review this pr |
|
Greetings @TallTed, |
|
Note that my single contribution to the I might suggest pinging the people who are "blamed" for the lines of |
Thank you, @TallTed. Those pointers were very helpful. |
|
Greetings @haniyakonain , Could you please have a look at my pr and approve for merge if possible . Would be really grateful since this pr has been open for more than 2 weeks for a simple |
Greetings @haniyakonain . Could you please have a review whenever you are available . |
jimkont
left a comment
jimkont
left a comment
There was a problem hiding this comment.
Thanks for improving the docs @vaibhav45sktech , I added some minor comments for a few links
README.md
Outdated
| - [Downloads](https://www.dbpedia.org/resources/downloads/) some data to work with. | ||
| - How to run from [Scala/Java](https://docs.scala-lang.org/tutorials/scala-with-maven.html) or from a [JAR.](https://docs.oracle.com/javase/tutorial/deployment/jar/run.html) | ||
|
|
||
| - Having different troubles? Check the [troubleshooting page](https://maven.apache.org/users/getting-help.html) or post on https://forum.dbpedia.org. |
There was a problem hiding this comment.
this should be https://www.dbpedia.org/sample-page/ instead of https://maven.apache.org/users/getting-help.html
README.md
Outdated
| - [Download](Downloads) some data to work with. | ||
| - How to run [from Scala/Java](Run-from-Java-or-Scala) or [from a JAR](Run-from-a-JAR). | ||
| - Having different troubles? Check the [troubleshooting page](Troubleshooting) or post on https://forum.dbpedia.org. | ||
| - Get help with the [Maven build](https://maven.apache.org/guides/introduction/introduction-to-the-lifecycle.html) or another form of [installation](https://maven.apache.org/install.html). |
There was a problem hiding this comment.
replace this line with a lint to the quick-start guide: https://github.com/dbpedia/extraction-framework/blob/master/documentation/quickstart.md
README.md
Outdated
| - Having different troubles? Check the [troubleshooting page](Troubleshooting) or post on https://forum.dbpedia.org. | ||
| - Get help with the [Maven build](https://maven.apache.org/guides/introduction/introduction-to-the-lifecycle.html) or another form of [installation](https://maven.apache.org/install.html). | ||
|
|
||
| - [Downloads](https://www.dbpedia.org/resources/downloads/) some data to work with. |
There was a problem hiding this comment.
change this to [DBpedia resources](https://www.dbpedia.org/resources/) to work with
README.md
Outdated
| - Get help with the [Maven build](https://maven.apache.org/guides/introduction/introduction-to-the-lifecycle.html) or another form of [installation](https://maven.apache.org/install.html). | ||
|
|
||
| - [Downloads](https://www.dbpedia.org/resources/downloads/) some data to work with. | ||
| - How to run from [Scala/Java](https://docs.scala-lang.org/tutorials/scala-with-maven.html) or from a [JAR.](https://docs.oracle.com/javase/tutorial/deployment/jar/run.html) |
There was a problem hiding this comment.
you can remove the How to run from [Scala/Java]... line, it is covered by the quick start guide above
|
Greetings @jimkont . I have done all the suggested changes which u mentioned , kindly review my pr . |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@README.md`:
- Line 127: Remove the leading space inside the markdown link text "[
quick-start guide]" in README.md so it becomes "[quick-start guide]"; update the
link text where it appears (the string "[ quick-start guide]") to remove the
interior space to satisfy MD039 (no-space-in-links).
♻️ Duplicate comments (1)
README.md (1)
131-131: Format bare URL as markdown link (previously flagged multiple times).Line 131 still contains a bare URL (
https://forum.dbpedia.org) which violates markdown linting rule MD034 (no-bare-urls). This issue has been flagged in multiple previous review comments but remains unresolved.🔧 Proposed fix
-- Having different troubles? Check the [troubleshooting page](https://www.dbpedia.org/sample-page) or post on https://forum.dbpedia.org. +- Having different troubles? Check the [troubleshooting page](https://www.dbpedia.org/sample-page) or post on the [DBpedia Forum](https://forum.dbpedia.org).Note: This fix also removes the extra space before "or" for consistency.
🧹 Nitpick comments (1)
README.md (1)
80-86: Consider using inline code formatting for namespace references.While the current markdown link formatting is consistent across all three namespace references, a previous review suggested using inline code formatting (backticks) instead of markdown links for these namespace identifiers. Inline code formatting (
org.dbpedia.extraction.ontology,org.dbpedia.extraction.dataparser,org.dbpedia.extraction.util) would be more conventional for displaying package/namespace names in technical documentation.♻️ Alternative formatting using inline code
-* **Ontology** Classes used to represent an ontology. Methods for both, reading and writing ontologies are provided. All classes are located in the namespace [org.dbpedia.extraction.ontology](https://github.com/dbpedia/extraction-framework/tree/master/core/src/main/scala/org/dbpedia/extraction/ontology) +* **Ontology** Classes used to represent an ontology. Methods for both, reading and writing ontologies are provided. All classes are located in the namespace `org.dbpedia.extraction.ontology` -* **DataParser** Parsers to extract data from nodes in the abstract syntax tree. All classes are located in the namespace [org.dbpedia.extraction.dataparser](https://github.com/dbpedia/extraction-framework/tree/master/core/src/main/scala/org/dbpedia/extraction/dataparser) +* **DataParser** Parsers to extract data from nodes in the abstract syntax tree. All classes are located in the namespace `org.dbpedia.extraction.dataparser` -* **Util** Various utility classes. All classes are located in the namespace [org.dbpedia.extraction.util](https://github.com/dbpedia/extraction-framework/tree/master/core/src/main/scala/org/dbpedia/extraction/util) +* **Util** Various utility classes. All classes are located in the namespace `org.dbpedia.extraction.util`
|
|
Greetings @jimkont sir Thanks for the approval, |
3 participants
Ontology,DataParser, andUtil sectionsBuild-from-Source-with-Maven,Installation,Run-from-Java-or-Scala,Run-from-a-JAR)solves issue #817
Summary by CodeRabbit
Documentation
Style
✏️ Tip: You can customize this high-level summary in your review settings.